Unify Cluster Language MQTT Reference

NOTE: This document has been autogenerated based on an extended DotDot specification.

This document outlines the JSON definitions for UCL cluster commands and attributes.

Some data types are structs, enums and bitmaps. See the UCL Structs, Enums and Bitmaps sections at the end of the document to see these definitions.

NOTE: Unify Protocol Controller and IoT Service support may vary.

\page basic Basic Cluster The following commands and attributes are accepted as JSON payloads for the Basic cluster.

\section basic_attrs Basic Attributes The following attribute topics are used to retrieve the Basic cluster state.

\subsection basic_attr_zcl_version Basic/ZCLVersion Attribute

MQTT Topic Pattern:

[PREFIX]/Basic/Attributes/ZCLVersion/Reported
[PREFIX]/Basic/Attributes/ZCLVersion/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Basic Cluster ZCLVersion Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ZCLVersion attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Basic/Attributes/ZCLVersion/+'

# Example output

ucl/by-unid/<UNID>/ep0/Basic/Attributes/ZCLVersion/Desired { "value": <DESIRED_ZCL_VERSION>}
ucl/by-unid/<UNID>/ep0/Basic/Attributes/ZCLVersion/Reported { "value": <REPORTED_ZCL_VERSION>}

\subsection basic_attr_application_version Basic/ApplicationVersion Attribute

MQTT Topic Pattern:

[PREFIX]/Basic/Attributes/ApplicationVersion/Reported
[PREFIX]/Basic/Attributes/ApplicationVersion/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Basic Cluster ApplicationVersion Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ApplicationVersion attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Basic/Attributes/ApplicationVersion/+'

# Example output

ucl/by-unid/<UNID>/ep0/Basic/Attributes/ApplicationVersion/Desired { "value": <DESIRED_APPLICATION_VERSION>}
ucl/by-unid/<UNID>/ep0/Basic/Attributes/ApplicationVersion/Reported { "value": <REPORTED_APPLICATION_VERSION>}

\subsection basic_attr_stack_version Basic/StackVersion Attribute

MQTT Topic Pattern:

[PREFIX]/Basic/Attributes/StackVersion/Reported
[PREFIX]/Basic/Attributes/StackVersion/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Basic Cluster StackVersion Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for StackVersion attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Basic/Attributes/StackVersion/+'

# Example output

ucl/by-unid/<UNID>/ep0/Basic/Attributes/StackVersion/Desired { "value": <DESIRED_STACK_VERSION>}
ucl/by-unid/<UNID>/ep0/Basic/Attributes/StackVersion/Reported { "value": <REPORTED_STACK_VERSION>}

\subsection basic_attr_hw_version Basic/HWVersion Attribute

MQTT Topic Pattern:

[PREFIX]/Basic/Attributes/HWVersion/Reported
[PREFIX]/Basic/Attributes/HWVersion/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Basic Cluster HWVersion Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for HWVersion attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Basic/Attributes/HWVersion/+'

# Example output

ucl/by-unid/<UNID>/ep0/Basic/Attributes/HWVersion/Desired { "value": <DESIRED_HW_VERSION>}
ucl/by-unid/<UNID>/ep0/Basic/Attributes/HWVersion/Reported { "value": <REPORTED_HW_VERSION>}

\subsection basic_attr_manufacturer_name Basic/ManufacturerName Attribute

MQTT Topic Pattern:

[PREFIX]/Basic/Attributes/ManufacturerName/Reported
[PREFIX]/Basic/Attributes/ManufacturerName/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Basic Cluster ManufacturerName Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ManufacturerName attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Basic/Attributes/ManufacturerName/+'

# Example output

ucl/by-unid/<UNID>/ep0/Basic/Attributes/ManufacturerName/Desired { "value": <DESIRED_MANUFACTURER_NAME>}
ucl/by-unid/<UNID>/ep0/Basic/Attributes/ManufacturerName/Reported { "value": <REPORTED_MANUFACTURER_NAME>}

\subsection basic_attr_model_identifier Basic/ModelIdentifier Attribute

MQTT Topic Pattern:

[PREFIX]/Basic/Attributes/ModelIdentifier/Reported
[PREFIX]/Basic/Attributes/ModelIdentifier/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Basic Cluster ModelIdentifier Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ModelIdentifier attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Basic/Attributes/ModelIdentifier/+'

# Example output

ucl/by-unid/<UNID>/ep0/Basic/Attributes/ModelIdentifier/Desired { "value": <DESIRED_MODEL_IDENTIFIER>}
ucl/by-unid/<UNID>/ep0/Basic/Attributes/ModelIdentifier/Reported { "value": <REPORTED_MODEL_IDENTIFIER>}

\subsection basic_attr_date_code Basic/DateCode Attribute

MQTT Topic Pattern:

[PREFIX]/Basic/Attributes/DateCode/Reported
[PREFIX]/Basic/Attributes/DateCode/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Basic Cluster DateCode Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DateCode attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Basic/Attributes/DateCode/+'

# Example output

ucl/by-unid/<UNID>/ep0/Basic/Attributes/DateCode/Desired { "value": <DESIRED_DATE_CODE>}
ucl/by-unid/<UNID>/ep0/Basic/Attributes/DateCode/Reported { "value": <REPORTED_DATE_CODE>}

\subsection basic_attr_power_source Basic/PowerSource Attribute

MQTT Topic Pattern:

[PREFIX]/Basic/Attributes/PowerSource/Reported
[PREFIX]/Basic/Attributes/PowerSource/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Basic Cluster PowerSource Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "BasicPowerSource"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for PowerSource attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Basic/Attributes/PowerSource/+'

# Example output

ucl/by-unid/<UNID>/ep0/Basic/Attributes/PowerSource/Desired { "value": <DESIRED_POWER_SOURCE>}
ucl/by-unid/<UNID>/ep0/Basic/Attributes/PowerSource/Reported { "value": <REPORTED_POWER_SOURCE>}

\subsection basic_attr_generic_device_class Basic/GenericDevice-Class Attribute

MQTT Topic Pattern:

[PREFIX]/Basic/Attributes/GenericDevice-Class/Reported
[PREFIX]/Basic/Attributes/GenericDevice-Class/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Basic Cluster GenericDevice-Class Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "BasicGenericDevice-Class"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for GenericDevice-Class attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Basic/Attributes/GenericDevice-Class/+'

# Example output

ucl/by-unid/<UNID>/ep0/Basic/Attributes/GenericDevice-Class/Desired { "value": <DESIRED_GENERIC_DEVICE_CLASS>}
ucl/by-unid/<UNID>/ep0/Basic/Attributes/GenericDevice-Class/Reported { "value": <REPORTED_GENERIC_DEVICE_CLASS>}

\subsection basic_attr_generic_device_type Basic/GenericDevice-Type Attribute

MQTT Topic Pattern:

[PREFIX]/Basic/Attributes/GenericDevice-Type/Reported
[PREFIX]/Basic/Attributes/GenericDevice-Type/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Basic Cluster GenericDevice-Type Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "BasicGenericDevice-Type"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for GenericDevice-Type attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Basic/Attributes/GenericDevice-Type/+'

# Example output

ucl/by-unid/<UNID>/ep0/Basic/Attributes/GenericDevice-Type/Desired { "value": <DESIRED_GENERIC_DEVICE_TYPE>}
ucl/by-unid/<UNID>/ep0/Basic/Attributes/GenericDevice-Type/Reported { "value": <REPORTED_GENERIC_DEVICE_TYPE>}

\subsection basic_attr_product_code Basic/ProductCode Attribute

MQTT Topic Pattern:

[PREFIX]/Basic/Attributes/ProductCode/Reported
[PREFIX]/Basic/Attributes/ProductCode/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Basic Cluster ProductCode Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ProductCode attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Basic/Attributes/ProductCode/+'

# Example output

ucl/by-unid/<UNID>/ep0/Basic/Attributes/ProductCode/Desired { "value": <DESIRED_PRODUCT_CODE>}
ucl/by-unid/<UNID>/ep0/Basic/Attributes/ProductCode/Reported { "value": <REPORTED_PRODUCT_CODE>}

\subsection basic_attr_producturl Basic/ProductURL Attribute

MQTT Topic Pattern:

[PREFIX]/Basic/Attributes/ProductURL/Reported
[PREFIX]/Basic/Attributes/ProductURL/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Basic Cluster ProductURL Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ProductURL attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Basic/Attributes/ProductURL/+'

# Example output

ucl/by-unid/<UNID>/ep0/Basic/Attributes/ProductURL/Desired { "value": <DESIRED_PRODUCTURL>}
ucl/by-unid/<UNID>/ep0/Basic/Attributes/ProductURL/Reported { "value": <REPORTED_PRODUCTURL>}

\subsection basic_attr_manufacturer_version_details Basic/ManufacturerVersionDetails Attribute

MQTT Topic Pattern:

[PREFIX]/Basic/Attributes/ManufacturerVersionDetails/Reported
[PREFIX]/Basic/Attributes/ManufacturerVersionDetails/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Basic Cluster ManufacturerVersionDetails Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ManufacturerVersionDetails attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Basic/Attributes/ManufacturerVersionDetails/+'

# Example output

ucl/by-unid/<UNID>/ep0/Basic/Attributes/ManufacturerVersionDetails/Desired { "value": <DESIRED_MANUFACTURER_VERSION_DETAILS>}
ucl/by-unid/<UNID>/ep0/Basic/Attributes/ManufacturerVersionDetails/Reported { "value": <REPORTED_MANUFACTURER_VERSION_DETAILS>}

\subsection basic_attr_serial_number Basic/SerialNumber Attribute

MQTT Topic Pattern:

[PREFIX]/Basic/Attributes/SerialNumber/Reported
[PREFIX]/Basic/Attributes/SerialNumber/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Basic Cluster SerialNumber Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for SerialNumber attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Basic/Attributes/SerialNumber/+'

# Example output

ucl/by-unid/<UNID>/ep0/Basic/Attributes/SerialNumber/Desired { "value": <DESIRED_SERIAL_NUMBER>}
ucl/by-unid/<UNID>/ep0/Basic/Attributes/SerialNumber/Reported { "value": <REPORTED_SERIAL_NUMBER>}

\subsection basic_attr_product_label Basic/ProductLabel Attribute

MQTT Topic Pattern:

[PREFIX]/Basic/Attributes/ProductLabel/Reported
[PREFIX]/Basic/Attributes/ProductLabel/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Basic Cluster ProductLabel Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ProductLabel attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Basic/Attributes/ProductLabel/+'

# Example output

ucl/by-unid/<UNID>/ep0/Basic/Attributes/ProductLabel/Desired { "value": <DESIRED_PRODUCT_LABEL>}
ucl/by-unid/<UNID>/ep0/Basic/Attributes/ProductLabel/Reported { "value": <REPORTED_PRODUCT_LABEL>}

\subsection basic_attr_location_description Basic/LocationDescription Attribute

MQTT Topic Pattern:

[PREFIX]/Basic/Attributes/LocationDescription/Reported
[PREFIX]/Basic/Attributes/LocationDescription/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Basic Cluster LocationDescription Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for LocationDescription attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Basic/Attributes/LocationDescription/+'

# Example output

ucl/by-unid/<UNID>/ep0/Basic/Attributes/LocationDescription/Desired { "value": <DESIRED_LOCATION_DESCRIPTION>}
ucl/by-unid/<UNID>/ep0/Basic/Attributes/LocationDescription/Reported { "value": <REPORTED_LOCATION_DESCRIPTION>}

\subsection basic_attr_physical_environment Basic/PhysicalEnvironment Attribute

MQTT Topic Pattern:

[PREFIX]/Basic/Attributes/PhysicalEnvironment/Reported
[PREFIX]/Basic/Attributes/PhysicalEnvironment/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Basic Cluster PhysicalEnvironment Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "BasicPhysicalEnvironment"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for PhysicalEnvironment attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Basic/Attributes/PhysicalEnvironment/+'

# Example output

ucl/by-unid/<UNID>/ep0/Basic/Attributes/PhysicalEnvironment/Desired { "value": <DESIRED_PHYSICAL_ENVIRONMENT>}
ucl/by-unid/<UNID>/ep0/Basic/Attributes/PhysicalEnvironment/Reported { "value": <REPORTED_PHYSICAL_ENVIRONMENT>}

\subsection basic_attr_device_enabled Basic/DeviceEnabled Attribute

MQTT Topic Pattern:

[PREFIX]/Basic/Attributes/DeviceEnabled/Reported
[PREFIX]/Basic/Attributes/DeviceEnabled/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Basic Cluster DeviceEnabled Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "boolean"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DeviceEnabled attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Basic/Attributes/DeviceEnabled/+'

# Example output

ucl/by-unid/<UNID>/ep0/Basic/Attributes/DeviceEnabled/Desired { "value": <DESIRED_DEVICE_ENABLED>}
ucl/by-unid/<UNID>/ep0/Basic/Attributes/DeviceEnabled/Reported { "value": <REPORTED_DEVICE_ENABLED>}

\subsection basic_attr_alarm_mask Basic/AlarmMask Attribute

MQTT Topic Pattern:

[PREFIX]/Basic/Attributes/AlarmMask/Reported
[PREFIX]/Basic/Attributes/AlarmMask/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Basic Cluster AlarmMask Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "BasicAlarmMask"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for AlarmMask attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Basic/Attributes/AlarmMask/+'

# Example output

ucl/by-unid/<UNID>/ep0/Basic/Attributes/AlarmMask/Desired { "value": <DESIRED_ALARM_MASK>}
ucl/by-unid/<UNID>/ep0/Basic/Attributes/AlarmMask/Reported { "value": <REPORTED_ALARM_MASK>}

\subsection basic_attr_disable_local_config Basic/DisableLocalConfig Attribute

MQTT Topic Pattern:

[PREFIX]/Basic/Attributes/DisableLocalConfig/Reported
[PREFIX]/Basic/Attributes/DisableLocalConfig/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Basic Cluster DisableLocalConfig Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "BasicDisableLocalConfig"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DisableLocalConfig attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Basic/Attributes/DisableLocalConfig/+'

# Example output

ucl/by-unid/<UNID>/ep0/Basic/Attributes/DisableLocalConfig/Desired { "value": <DESIRED_DISABLE_LOCAL_CONFIG>}
ucl/by-unid/<UNID>/ep0/Basic/Attributes/DisableLocalConfig/Reported { "value": <REPORTED_DISABLE_LOCAL_CONFIG>}

\subsection basic_attr_sw_buildid Basic/SWBuildID Attribute

MQTT Topic Pattern:

[PREFIX]/Basic/Attributes/SWBuildID/Reported
[PREFIX]/Basic/Attributes/SWBuildID/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Basic Cluster SWBuildID Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for SWBuildID attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Basic/Attributes/SWBuildID/+'

# Example output

ucl/by-unid/<UNID>/ep0/Basic/Attributes/SWBuildID/Desired { "value": <DESIRED_SW_BUILDID>}
ucl/by-unid/<UNID>/ep0/Basic/Attributes/SWBuildID/Reported { "value": <REPORTED_SW_BUILDID>}

\subsection basic_attr_cluster_revision Basic/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/Basic/Attributes/ClusterRevision/Reported
[PREFIX]/Basic/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Basic Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Basic/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/Basic/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/Basic/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section basic_recv_cmd_support Basic Command Support

MQTT Topic Pattern:

[PREFIX]/Basic/SupportedCommands
[PREFIX]/Basic/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Basic Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
              "ResetToFactoryDefaults",
              "WriteAttributes",
              "ForceReadAttributes"
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for Basic cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Basic/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/Basic/SupportedCommands { "value": ["ResetToFactoryDefaults","WriteAttributes", "ForceReadAttributes"] }

To see supported generated commands for Basic cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Basic/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/Basic/SupportedGeneratedCommands { "value": [] }

\section basic_cmds Basic Commands

\subsection basic_reset_to_factory_defaults_cmd Basic/ResetToFactoryDefaults Command

MQTT Topic Pattern:

[PREFIX]/Basic/Commands/ResetToFactoryDefaults
[PREFIX]/Basic/GeneratedCommands/ResetToFactoryDefaults

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Basic Cluster ResetToFactoryDefaults Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
  ]
}

Example Mosquitto CLI Tool Usage

To send a Basic/ResetToFactoryDefaults command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Basic/Commands/ResetToFactoryDefaults' -m  '{  }'

To receive a Basic/ResetToFactoryDefaults generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Basic/GeneratedCommands/ResetToFactoryDefaults'

\subsection basic_write_attr_cmd Basic/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/Basic/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Basic Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
    "LocationDescription": {
      "type": "string"
    },
    "PhysicalEnvironment": {
      "type": "BasicPhysicalEnvironment"
    },
    "DeviceEnabled": {
      "type": "boolean"
    },
    "AlarmMask": {
      "type": "BasicAlarmMask"
    },
    "DisableLocalConfig": {
      "type": "BasicDisableLocalConfig"
    },
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all Basic attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Basic/Commands/WriteAttributes' -m  '{ "LocationDescription": <LOCATION_DESCRIPTION_VALUE> ,"PhysicalEnvironment": <PHYSICAL_ENVIRONMENT_VALUE> ,"DeviceEnabled": <DEVICE_ENABLED_VALUE> ,"AlarmMask": <ALARM_MASK_VALUE> ,"DisableLocalConfig": <DISABLE_LOCAL_CONFIG_VALUE> , }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection basic_force_read_attr_cmd Basic/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/Basic/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Basic Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "ZCLVersion",
          "ApplicationVersion",
          "StackVersion",
          "HWVersion",
          "ManufacturerName",
          "ModelIdentifier",
          "DateCode",
          "PowerSource",
          "GenericDevice-Class",
          "GenericDevice-Type",
          "ProductCode",
          "ProductURL",
          "ManufacturerVersionDetails",
          "SerialNumber",
          "ProductLabel",
          "LocationDescription",
          "PhysicalEnvironment",
          "DeviceEnabled",
          "AlarmMask",
          "DisableLocalConfig",
          "SWBuildID"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all Basic attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Basic/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the Basic attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Basic/Commands/ForceReadAttributes' -m  '{ "value": ["ZCLVersion"] }'

\page power_configuration PowerConfiguration Cluster The following commands and attributes are accepted as JSON payloads for the PowerConfiguration cluster.

\section power_configuration_attrs PowerConfiguration Attributes The following attribute topics are used to retrieve the PowerConfiguration cluster state.

\subsection power_configuration_attr_mains_voltage PowerConfiguration/MainsVoltage Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/MainsVoltage/Reported
[PREFIX]/PowerConfiguration/Attributes/MainsVoltage/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster MainsVoltage Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MainsVoltage attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/MainsVoltage/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/MainsVoltage/Desired { "value": <DESIRED_MAINS_VOLTAGE>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/MainsVoltage/Reported { "value": <REPORTED_MAINS_VOLTAGE>}

\subsection power_configuration_attr_mains_frequency PowerConfiguration/MainsFrequency Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/MainsFrequency/Reported
[PREFIX]/PowerConfiguration/Attributes/MainsFrequency/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster MainsFrequency Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MainsFrequency attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/MainsFrequency/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/MainsFrequency/Desired { "value": <DESIRED_MAINS_FREQUENCY>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/MainsFrequency/Reported { "value": <REPORTED_MAINS_FREQUENCY>}

\subsection power_configuration_attr_mains_alarm_mask PowerConfiguration/MainsAlarmMask Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/MainsAlarmMask/Reported
[PREFIX]/PowerConfiguration/Attributes/MainsAlarmMask/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster MainsAlarmMask Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "PowerConfigurationMainsAlarmMask"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MainsAlarmMask attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/MainsAlarmMask/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/MainsAlarmMask/Desired { "value": <DESIRED_MAINS_ALARM_MASK>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/MainsAlarmMask/Reported { "value": <REPORTED_MAINS_ALARM_MASK>}

\subsection power_configuration_attr_mains_voltage_min_threshold PowerConfiguration/MainsVoltageMinThreshold Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/MainsVoltageMinThreshold/Reported
[PREFIX]/PowerConfiguration/Attributes/MainsVoltageMinThreshold/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster MainsVoltageMinThreshold Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MainsVoltageMinThreshold attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/MainsVoltageMinThreshold/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/MainsVoltageMinThreshold/Desired { "value": <DESIRED_MAINS_VOLTAGE_MIN_THRESHOLD>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/MainsVoltageMinThreshold/Reported { "value": <REPORTED_MAINS_VOLTAGE_MIN_THRESHOLD>}

\subsection power_configuration_attr_mains_voltage_max_threshold PowerConfiguration/MainsVoltageMaxThreshold Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/MainsVoltageMaxThreshold/Reported
[PREFIX]/PowerConfiguration/Attributes/MainsVoltageMaxThreshold/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster MainsVoltageMaxThreshold Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MainsVoltageMaxThreshold attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/MainsVoltageMaxThreshold/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/MainsVoltageMaxThreshold/Desired { "value": <DESIRED_MAINS_VOLTAGE_MAX_THRESHOLD>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/MainsVoltageMaxThreshold/Reported { "value": <REPORTED_MAINS_VOLTAGE_MAX_THRESHOLD>}

\subsection power_configuration_attr_mains_voltage_dwell_trip_point PowerConfiguration/MainsVoltageDwellTripPoint Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/MainsVoltageDwellTripPoint/Reported
[PREFIX]/PowerConfiguration/Attributes/MainsVoltageDwellTripPoint/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster MainsVoltageDwellTripPoint Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MainsVoltageDwellTripPoint attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/MainsVoltageDwellTripPoint/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/MainsVoltageDwellTripPoint/Desired { "value": <DESIRED_MAINS_VOLTAGE_DWELL_TRIP_POINT>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/MainsVoltageDwellTripPoint/Reported { "value": <REPORTED_MAINS_VOLTAGE_DWELL_TRIP_POINT>}

\subsection power_configuration_attr_battery_voltage PowerConfiguration/BatteryVoltage Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/BatteryVoltage/Reported
[PREFIX]/PowerConfiguration/Attributes/BatteryVoltage/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster BatteryVoltage Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for BatteryVoltage attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/BatteryVoltage/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/BatteryVoltage/Desired { "value": <DESIRED_BATTERY_VOLTAGE>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/BatteryVoltage/Reported { "value": <REPORTED_BATTERY_VOLTAGE>}

\subsection power_configuration_attr_battery_percentage_remaining PowerConfiguration/BatteryPercentageRemaining Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/BatteryPercentageRemaining/Reported
[PREFIX]/PowerConfiguration/Attributes/BatteryPercentageRemaining/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster BatteryPercentageRemaining Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for BatteryPercentageRemaining attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/BatteryPercentageRemaining/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/BatteryPercentageRemaining/Desired { "value": <DESIRED_BATTERY_PERCENTAGE_REMAINING>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/BatteryPercentageRemaining/Reported { "value": <REPORTED_BATTERY_PERCENTAGE_REMAINING>}

\subsection power_configuration_attr_battery_manufacturer PowerConfiguration/BatteryManufacturer Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/BatteryManufacturer/Reported
[PREFIX]/PowerConfiguration/Attributes/BatteryManufacturer/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster BatteryManufacturer Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for BatteryManufacturer attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/BatteryManufacturer/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/BatteryManufacturer/Desired { "value": <DESIRED_BATTERY_MANUFACTURER>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/BatteryManufacturer/Reported { "value": <REPORTED_BATTERY_MANUFACTURER>}

\subsection power_configuration_attr_battery_size PowerConfiguration/BatterySize Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/BatterySize/Reported
[PREFIX]/PowerConfiguration/Attributes/BatterySize/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster BatterySize Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "BatterySize"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for BatterySize attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/BatterySize/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/BatterySize/Desired { "value": <DESIRED_BATTERY_SIZE>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/BatterySize/Reported { "value": <REPORTED_BATTERY_SIZE>}

\subsection power_configuration_attr_batterya_hr_rating PowerConfiguration/BatteryAHrRating Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/BatteryAHrRating/Reported
[PREFIX]/PowerConfiguration/Attributes/BatteryAHrRating/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster BatteryAHrRating Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for BatteryAHrRating attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/BatteryAHrRating/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/BatteryAHrRating/Desired { "value": <DESIRED_BATTERYA_HR_RATING>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/BatteryAHrRating/Reported { "value": <REPORTED_BATTERYA_HR_RATING>}

\subsection power_configuration_attr_battery_quantity PowerConfiguration/BatteryQuantity Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/BatteryQuantity/Reported
[PREFIX]/PowerConfiguration/Attributes/BatteryQuantity/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster BatteryQuantity Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for BatteryQuantity attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/BatteryQuantity/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/BatteryQuantity/Desired { "value": <DESIRED_BATTERY_QUANTITY>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/BatteryQuantity/Reported { "value": <REPORTED_BATTERY_QUANTITY>}

\subsection power_configuration_attr_battery_rated_voltage PowerConfiguration/BatteryRatedVoltage Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/BatteryRatedVoltage/Reported
[PREFIX]/PowerConfiguration/Attributes/BatteryRatedVoltage/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster BatteryRatedVoltage Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for BatteryRatedVoltage attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/BatteryRatedVoltage/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/BatteryRatedVoltage/Desired { "value": <DESIRED_BATTERY_RATED_VOLTAGE>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/BatteryRatedVoltage/Reported { "value": <REPORTED_BATTERY_RATED_VOLTAGE>}

\subsection power_configuration_attr_battery_alarm_mask PowerConfiguration/BatteryAlarmMask Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/BatteryAlarmMask/Reported
[PREFIX]/PowerConfiguration/Attributes/BatteryAlarmMask/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster BatteryAlarmMask Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "BatteryAlarmMask"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for BatteryAlarmMask attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/BatteryAlarmMask/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/BatteryAlarmMask/Desired { "value": <DESIRED_BATTERY_ALARM_MASK>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/BatteryAlarmMask/Reported { "value": <REPORTED_BATTERY_ALARM_MASK>}

\subsection power_configuration_attr_battery_voltage_min_threshold PowerConfiguration/BatteryVoltageMinThreshold Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/BatteryVoltageMinThreshold/Reported
[PREFIX]/PowerConfiguration/Attributes/BatteryVoltageMinThreshold/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster BatteryVoltageMinThreshold Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for BatteryVoltageMinThreshold attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/BatteryVoltageMinThreshold/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/BatteryVoltageMinThreshold/Desired { "value": <DESIRED_BATTERY_VOLTAGE_MIN_THRESHOLD>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/BatteryVoltageMinThreshold/Reported { "value": <REPORTED_BATTERY_VOLTAGE_MIN_THRESHOLD>}

\subsection power_configuration_attr_battery_voltage_threshold1 PowerConfiguration/BatteryVoltageThreshold1 Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/BatteryVoltageThreshold1/Reported
[PREFIX]/PowerConfiguration/Attributes/BatteryVoltageThreshold1/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster BatteryVoltageThreshold1 Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for BatteryVoltageThreshold1 attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/BatteryVoltageThreshold1/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/BatteryVoltageThreshold1/Desired { "value": <DESIRED_BATTERY_VOLTAGE_THRESHOLD1>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/BatteryVoltageThreshold1/Reported { "value": <REPORTED_BATTERY_VOLTAGE_THRESHOLD1>}

\subsection power_configuration_attr_battery_voltage_threshold2 PowerConfiguration/BatteryVoltageThreshold2 Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/BatteryVoltageThreshold2/Reported
[PREFIX]/PowerConfiguration/Attributes/BatteryVoltageThreshold2/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster BatteryVoltageThreshold2 Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for BatteryVoltageThreshold2 attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/BatteryVoltageThreshold2/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/BatteryVoltageThreshold2/Desired { "value": <DESIRED_BATTERY_VOLTAGE_THRESHOLD2>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/BatteryVoltageThreshold2/Reported { "value": <REPORTED_BATTERY_VOLTAGE_THRESHOLD2>}

\subsection power_configuration_attr_battery_voltage_threshold3 PowerConfiguration/BatteryVoltageThreshold3 Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/BatteryVoltageThreshold3/Reported
[PREFIX]/PowerConfiguration/Attributes/BatteryVoltageThreshold3/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster BatteryVoltageThreshold3 Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for BatteryVoltageThreshold3 attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/BatteryVoltageThreshold3/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/BatteryVoltageThreshold3/Desired { "value": <DESIRED_BATTERY_VOLTAGE_THRESHOLD3>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/BatteryVoltageThreshold3/Reported { "value": <REPORTED_BATTERY_VOLTAGE_THRESHOLD3>}

\subsection power_configuration_attr_battery_percentage_min_threshold PowerConfiguration/BatteryPercentageMinThreshold Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/BatteryPercentageMinThreshold/Reported
[PREFIX]/PowerConfiguration/Attributes/BatteryPercentageMinThreshold/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster BatteryPercentageMinThreshold Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for BatteryPercentageMinThreshold attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/BatteryPercentageMinThreshold/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/BatteryPercentageMinThreshold/Desired { "value": <DESIRED_BATTERY_PERCENTAGE_MIN_THRESHOLD>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/BatteryPercentageMinThreshold/Reported { "value": <REPORTED_BATTERY_PERCENTAGE_MIN_THRESHOLD>}

\subsection power_configuration_attr_battery_percentage_threshold1 PowerConfiguration/BatteryPercentageThreshold1 Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/BatteryPercentageThreshold1/Reported
[PREFIX]/PowerConfiguration/Attributes/BatteryPercentageThreshold1/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster BatteryPercentageThreshold1 Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for BatteryPercentageThreshold1 attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/BatteryPercentageThreshold1/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/BatteryPercentageThreshold1/Desired { "value": <DESIRED_BATTERY_PERCENTAGE_THRESHOLD1>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/BatteryPercentageThreshold1/Reported { "value": <REPORTED_BATTERY_PERCENTAGE_THRESHOLD1>}

\subsection power_configuration_attr_battery_percentage_threshold2 PowerConfiguration/BatteryPercentageThreshold2 Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/BatteryPercentageThreshold2/Reported
[PREFIX]/PowerConfiguration/Attributes/BatteryPercentageThreshold2/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster BatteryPercentageThreshold2 Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for BatteryPercentageThreshold2 attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/BatteryPercentageThreshold2/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/BatteryPercentageThreshold2/Desired { "value": <DESIRED_BATTERY_PERCENTAGE_THRESHOLD2>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/BatteryPercentageThreshold2/Reported { "value": <REPORTED_BATTERY_PERCENTAGE_THRESHOLD2>}

\subsection power_configuration_attr_battery_percentage_threshold3 PowerConfiguration/BatteryPercentageThreshold3 Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/BatteryPercentageThreshold3/Reported
[PREFIX]/PowerConfiguration/Attributes/BatteryPercentageThreshold3/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster BatteryPercentageThreshold3 Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for BatteryPercentageThreshold3 attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/BatteryPercentageThreshold3/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/BatteryPercentageThreshold3/Desired { "value": <DESIRED_BATTERY_PERCENTAGE_THRESHOLD3>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/BatteryPercentageThreshold3/Reported { "value": <REPORTED_BATTERY_PERCENTAGE_THRESHOLD3>}

\subsection power_configuration_attr_battery_alarm_state PowerConfiguration/BatteryAlarmState Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/BatteryAlarmState/Reported
[PREFIX]/PowerConfiguration/Attributes/BatteryAlarmState/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster BatteryAlarmState Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "BatteryAlarmState"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for BatteryAlarmState attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/BatteryAlarmState/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/BatteryAlarmState/Desired { "value": <DESIRED_BATTERY_ALARM_STATE>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/BatteryAlarmState/Reported { "value": <REPORTED_BATTERY_ALARM_STATE>}

\subsection power_configuration_attr_battery2_voltage PowerConfiguration/Battery2Voltage Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/Battery2Voltage/Reported
[PREFIX]/PowerConfiguration/Attributes/Battery2Voltage/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster Battery2Voltage Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Battery2Voltage attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/Battery2Voltage/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery2Voltage/Desired { "value": <DESIRED_BATTERY2_VOLTAGE>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery2Voltage/Reported { "value": <REPORTED_BATTERY2_VOLTAGE>}

\subsection power_configuration_attr_battery2_percentage_remaining PowerConfiguration/Battery2PercentageRemaining Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/Battery2PercentageRemaining/Reported
[PREFIX]/PowerConfiguration/Attributes/Battery2PercentageRemaining/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster Battery2PercentageRemaining Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Battery2PercentageRemaining attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/Battery2PercentageRemaining/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery2PercentageRemaining/Desired { "value": <DESIRED_BATTERY2_PERCENTAGE_REMAINING>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery2PercentageRemaining/Reported { "value": <REPORTED_BATTERY2_PERCENTAGE_REMAINING>}

\subsection power_configuration_attr_battery2_manufacturer PowerConfiguration/Battery2Manufacturer Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/Battery2Manufacturer/Reported
[PREFIX]/PowerConfiguration/Attributes/Battery2Manufacturer/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster Battery2Manufacturer Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Battery2Manufacturer attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/Battery2Manufacturer/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery2Manufacturer/Desired { "value": <DESIRED_BATTERY2_MANUFACTURER>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery2Manufacturer/Reported { "value": <REPORTED_BATTERY2_MANUFACTURER>}

\subsection power_configuration_attr_battery2_size PowerConfiguration/Battery2Size Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/Battery2Size/Reported
[PREFIX]/PowerConfiguration/Attributes/Battery2Size/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster Battery2Size Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "BatterySize"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Battery2Size attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/Battery2Size/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery2Size/Desired { "value": <DESIRED_BATTERY2_SIZE>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery2Size/Reported { "value": <REPORTED_BATTERY2_SIZE>}

\subsection power_configuration_attr_battery2a_hr_rating PowerConfiguration/Battery2AHrRating Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/Battery2AHrRating/Reported
[PREFIX]/PowerConfiguration/Attributes/Battery2AHrRating/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster Battery2AHrRating Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Battery2AHrRating attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/Battery2AHrRating/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery2AHrRating/Desired { "value": <DESIRED_BATTERY2A_HR_RATING>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery2AHrRating/Reported { "value": <REPORTED_BATTERY2A_HR_RATING>}

\subsection power_configuration_attr_battery2_quantity PowerConfiguration/Battery2Quantity Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/Battery2Quantity/Reported
[PREFIX]/PowerConfiguration/Attributes/Battery2Quantity/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster Battery2Quantity Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Battery2Quantity attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/Battery2Quantity/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery2Quantity/Desired { "value": <DESIRED_BATTERY2_QUANTITY>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery2Quantity/Reported { "value": <REPORTED_BATTERY2_QUANTITY>}

\subsection power_configuration_attr_battery2_rated_voltage PowerConfiguration/Battery2RatedVoltage Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/Battery2RatedVoltage/Reported
[PREFIX]/PowerConfiguration/Attributes/Battery2RatedVoltage/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster Battery2RatedVoltage Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Battery2RatedVoltage attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/Battery2RatedVoltage/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery2RatedVoltage/Desired { "value": <DESIRED_BATTERY2_RATED_VOLTAGE>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery2RatedVoltage/Reported { "value": <REPORTED_BATTERY2_RATED_VOLTAGE>}

\subsection power_configuration_attr_battery2_alarm_mask PowerConfiguration/Battery2AlarmMask Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/Battery2AlarmMask/Reported
[PREFIX]/PowerConfiguration/Attributes/Battery2AlarmMask/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster Battery2AlarmMask Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "BatteryAlarmMask"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Battery2AlarmMask attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/Battery2AlarmMask/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery2AlarmMask/Desired { "value": <DESIRED_BATTERY2_ALARM_MASK>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery2AlarmMask/Reported { "value": <REPORTED_BATTERY2_ALARM_MASK>}

\subsection power_configuration_attr_battery2_voltage_min_threshold PowerConfiguration/Battery2VoltageMinThreshold Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/Battery2VoltageMinThreshold/Reported
[PREFIX]/PowerConfiguration/Attributes/Battery2VoltageMinThreshold/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster Battery2VoltageMinThreshold Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Battery2VoltageMinThreshold attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/Battery2VoltageMinThreshold/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery2VoltageMinThreshold/Desired { "value": <DESIRED_BATTERY2_VOLTAGE_MIN_THRESHOLD>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery2VoltageMinThreshold/Reported { "value": <REPORTED_BATTERY2_VOLTAGE_MIN_THRESHOLD>}

\subsection power_configuration_attr_battery2_voltage_threshold1 PowerConfiguration/Battery2VoltageThreshold1 Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/Battery2VoltageThreshold1/Reported
[PREFIX]/PowerConfiguration/Attributes/Battery2VoltageThreshold1/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster Battery2VoltageThreshold1 Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Battery2VoltageThreshold1 attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/Battery2VoltageThreshold1/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery2VoltageThreshold1/Desired { "value": <DESIRED_BATTERY2_VOLTAGE_THRESHOLD1>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery2VoltageThreshold1/Reported { "value": <REPORTED_BATTERY2_VOLTAGE_THRESHOLD1>}

\subsection power_configuration_attr_battery2_voltage_threshold2 PowerConfiguration/Battery2VoltageThreshold2 Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/Battery2VoltageThreshold2/Reported
[PREFIX]/PowerConfiguration/Attributes/Battery2VoltageThreshold2/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster Battery2VoltageThreshold2 Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Battery2VoltageThreshold2 attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/Battery2VoltageThreshold2/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery2VoltageThreshold2/Desired { "value": <DESIRED_BATTERY2_VOLTAGE_THRESHOLD2>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery2VoltageThreshold2/Reported { "value": <REPORTED_BATTERY2_VOLTAGE_THRESHOLD2>}

\subsection power_configuration_attr_battery2_voltage_threshold3 PowerConfiguration/Battery2VoltageThreshold3 Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/Battery2VoltageThreshold3/Reported
[PREFIX]/PowerConfiguration/Attributes/Battery2VoltageThreshold3/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster Battery2VoltageThreshold3 Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Battery2VoltageThreshold3 attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/Battery2VoltageThreshold3/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery2VoltageThreshold3/Desired { "value": <DESIRED_BATTERY2_VOLTAGE_THRESHOLD3>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery2VoltageThreshold3/Reported { "value": <REPORTED_BATTERY2_VOLTAGE_THRESHOLD3>}

\subsection power_configuration_attr_battery2_percentage_min_threshold PowerConfiguration/Battery2PercentageMinThreshold Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/Battery2PercentageMinThreshold/Reported
[PREFIX]/PowerConfiguration/Attributes/Battery2PercentageMinThreshold/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster Battery2PercentageMinThreshold Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Battery2PercentageMinThreshold attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/Battery2PercentageMinThreshold/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery2PercentageMinThreshold/Desired { "value": <DESIRED_BATTERY2_PERCENTAGE_MIN_THRESHOLD>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery2PercentageMinThreshold/Reported { "value": <REPORTED_BATTERY2_PERCENTAGE_MIN_THRESHOLD>}

\subsection power_configuration_attr_battery2_percentage_threshold1 PowerConfiguration/Battery2PercentageThreshold1 Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/Battery2PercentageThreshold1/Reported
[PREFIX]/PowerConfiguration/Attributes/Battery2PercentageThreshold1/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster Battery2PercentageThreshold1 Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Battery2PercentageThreshold1 attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/Battery2PercentageThreshold1/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery2PercentageThreshold1/Desired { "value": <DESIRED_BATTERY2_PERCENTAGE_THRESHOLD1>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery2PercentageThreshold1/Reported { "value": <REPORTED_BATTERY2_PERCENTAGE_THRESHOLD1>}

\subsection power_configuration_attr_battery2_percentage_threshold2 PowerConfiguration/Battery2PercentageThreshold2 Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/Battery2PercentageThreshold2/Reported
[PREFIX]/PowerConfiguration/Attributes/Battery2PercentageThreshold2/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster Battery2PercentageThreshold2 Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Battery2PercentageThreshold2 attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/Battery2PercentageThreshold2/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery2PercentageThreshold2/Desired { "value": <DESIRED_BATTERY2_PERCENTAGE_THRESHOLD2>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery2PercentageThreshold2/Reported { "value": <REPORTED_BATTERY2_PERCENTAGE_THRESHOLD2>}

\subsection power_configuration_attr_battery2_percentage_threshold3 PowerConfiguration/Battery2PercentageThreshold3 Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/Battery2PercentageThreshold3/Reported
[PREFIX]/PowerConfiguration/Attributes/Battery2PercentageThreshold3/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster Battery2PercentageThreshold3 Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Battery2PercentageThreshold3 attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/Battery2PercentageThreshold3/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery2PercentageThreshold3/Desired { "value": <DESIRED_BATTERY2_PERCENTAGE_THRESHOLD3>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery2PercentageThreshold3/Reported { "value": <REPORTED_BATTERY2_PERCENTAGE_THRESHOLD3>}

\subsection power_configuration_attr_battery2_alarm_state PowerConfiguration/Battery2AlarmState Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/Battery2AlarmState/Reported
[PREFIX]/PowerConfiguration/Attributes/Battery2AlarmState/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster Battery2AlarmState Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "BatteryAlarmState"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Battery2AlarmState attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/Battery2AlarmState/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery2AlarmState/Desired { "value": <DESIRED_BATTERY2_ALARM_STATE>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery2AlarmState/Reported { "value": <REPORTED_BATTERY2_ALARM_STATE>}

\subsection power_configuration_attr_battery3_voltage PowerConfiguration/Battery3Voltage Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/Battery3Voltage/Reported
[PREFIX]/PowerConfiguration/Attributes/Battery3Voltage/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster Battery3Voltage Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Battery3Voltage attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/Battery3Voltage/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery3Voltage/Desired { "value": <DESIRED_BATTERY3_VOLTAGE>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery3Voltage/Reported { "value": <REPORTED_BATTERY3_VOLTAGE>}

\subsection power_configuration_attr_battery3_percentage_remaining PowerConfiguration/Battery3PercentageRemaining Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/Battery3PercentageRemaining/Reported
[PREFIX]/PowerConfiguration/Attributes/Battery3PercentageRemaining/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster Battery3PercentageRemaining Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Battery3PercentageRemaining attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/Battery3PercentageRemaining/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery3PercentageRemaining/Desired { "value": <DESIRED_BATTERY3_PERCENTAGE_REMAINING>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery3PercentageRemaining/Reported { "value": <REPORTED_BATTERY3_PERCENTAGE_REMAINING>}

\subsection power_configuration_attr_battery3_manufacturer PowerConfiguration/Battery3Manufacturer Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/Battery3Manufacturer/Reported
[PREFIX]/PowerConfiguration/Attributes/Battery3Manufacturer/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster Battery3Manufacturer Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Battery3Manufacturer attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/Battery3Manufacturer/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery3Manufacturer/Desired { "value": <DESIRED_BATTERY3_MANUFACTURER>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery3Manufacturer/Reported { "value": <REPORTED_BATTERY3_MANUFACTURER>}

\subsection power_configuration_attr_battery3_size PowerConfiguration/Battery3Size Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/Battery3Size/Reported
[PREFIX]/PowerConfiguration/Attributes/Battery3Size/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster Battery3Size Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "BatterySize"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Battery3Size attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/Battery3Size/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery3Size/Desired { "value": <DESIRED_BATTERY3_SIZE>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery3Size/Reported { "value": <REPORTED_BATTERY3_SIZE>}

\subsection power_configuration_attr_battery3a_hr_rating PowerConfiguration/Battery3AHrRating Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/Battery3AHrRating/Reported
[PREFIX]/PowerConfiguration/Attributes/Battery3AHrRating/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster Battery3AHrRating Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Battery3AHrRating attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/Battery3AHrRating/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery3AHrRating/Desired { "value": <DESIRED_BATTERY3A_HR_RATING>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery3AHrRating/Reported { "value": <REPORTED_BATTERY3A_HR_RATING>}

\subsection power_configuration_attr_battery3_quantity PowerConfiguration/Battery3Quantity Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/Battery3Quantity/Reported
[PREFIX]/PowerConfiguration/Attributes/Battery3Quantity/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster Battery3Quantity Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Battery3Quantity attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/Battery3Quantity/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery3Quantity/Desired { "value": <DESIRED_BATTERY3_QUANTITY>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery3Quantity/Reported { "value": <REPORTED_BATTERY3_QUANTITY>}

\subsection power_configuration_attr_battery3_rated_voltage PowerConfiguration/Battery3RatedVoltage Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/Battery3RatedVoltage/Reported
[PREFIX]/PowerConfiguration/Attributes/Battery3RatedVoltage/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster Battery3RatedVoltage Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Battery3RatedVoltage attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/Battery3RatedVoltage/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery3RatedVoltage/Desired { "value": <DESIRED_BATTERY3_RATED_VOLTAGE>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery3RatedVoltage/Reported { "value": <REPORTED_BATTERY3_RATED_VOLTAGE>}

\subsection power_configuration_attr_battery3_alarm_mask PowerConfiguration/Battery3AlarmMask Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/Battery3AlarmMask/Reported
[PREFIX]/PowerConfiguration/Attributes/Battery3AlarmMask/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster Battery3AlarmMask Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "BatteryAlarmMask"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Battery3AlarmMask attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/Battery3AlarmMask/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery3AlarmMask/Desired { "value": <DESIRED_BATTERY3_ALARM_MASK>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery3AlarmMask/Reported { "value": <REPORTED_BATTERY3_ALARM_MASK>}

\subsection power_configuration_attr_battery3_voltage_min_threshold PowerConfiguration/Battery3VoltageMinThreshold Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/Battery3VoltageMinThreshold/Reported
[PREFIX]/PowerConfiguration/Attributes/Battery3VoltageMinThreshold/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster Battery3VoltageMinThreshold Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Battery3VoltageMinThreshold attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/Battery3VoltageMinThreshold/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery3VoltageMinThreshold/Desired { "value": <DESIRED_BATTERY3_VOLTAGE_MIN_THRESHOLD>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery3VoltageMinThreshold/Reported { "value": <REPORTED_BATTERY3_VOLTAGE_MIN_THRESHOLD>}

\subsection power_configuration_attr_battery3_voltage_threshold1 PowerConfiguration/Battery3VoltageThreshold1 Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/Battery3VoltageThreshold1/Reported
[PREFIX]/PowerConfiguration/Attributes/Battery3VoltageThreshold1/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster Battery3VoltageThreshold1 Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Battery3VoltageThreshold1 attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/Battery3VoltageThreshold1/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery3VoltageThreshold1/Desired { "value": <DESIRED_BATTERY3_VOLTAGE_THRESHOLD1>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery3VoltageThreshold1/Reported { "value": <REPORTED_BATTERY3_VOLTAGE_THRESHOLD1>}

\subsection power_configuration_attr_battery3_voltage_threshold2 PowerConfiguration/Battery3VoltageThreshold2 Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/Battery3VoltageThreshold2/Reported
[PREFIX]/PowerConfiguration/Attributes/Battery3VoltageThreshold2/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster Battery3VoltageThreshold2 Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Battery3VoltageThreshold2 attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/Battery3VoltageThreshold2/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery3VoltageThreshold2/Desired { "value": <DESIRED_BATTERY3_VOLTAGE_THRESHOLD2>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery3VoltageThreshold2/Reported { "value": <REPORTED_BATTERY3_VOLTAGE_THRESHOLD2>}

\subsection power_configuration_attr_battery3_voltage_threshold3 PowerConfiguration/Battery3VoltageThreshold3 Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/Battery3VoltageThreshold3/Reported
[PREFIX]/PowerConfiguration/Attributes/Battery3VoltageThreshold3/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster Battery3VoltageThreshold3 Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Battery3VoltageThreshold3 attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/Battery3VoltageThreshold3/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery3VoltageThreshold3/Desired { "value": <DESIRED_BATTERY3_VOLTAGE_THRESHOLD3>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery3VoltageThreshold3/Reported { "value": <REPORTED_BATTERY3_VOLTAGE_THRESHOLD3>}

\subsection power_configuration_attr_battery3_percentage_min_threshold PowerConfiguration/Battery3PercentageMinThreshold Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/Battery3PercentageMinThreshold/Reported
[PREFIX]/PowerConfiguration/Attributes/Battery3PercentageMinThreshold/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster Battery3PercentageMinThreshold Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Battery3PercentageMinThreshold attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/Battery3PercentageMinThreshold/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery3PercentageMinThreshold/Desired { "value": <DESIRED_BATTERY3_PERCENTAGE_MIN_THRESHOLD>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery3PercentageMinThreshold/Reported { "value": <REPORTED_BATTERY3_PERCENTAGE_MIN_THRESHOLD>}

\subsection power_configuration_attr_battery3_percentage_threshold1 PowerConfiguration/Battery3PercentageThreshold1 Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/Battery3PercentageThreshold1/Reported
[PREFIX]/PowerConfiguration/Attributes/Battery3PercentageThreshold1/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster Battery3PercentageThreshold1 Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Battery3PercentageThreshold1 attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/Battery3PercentageThreshold1/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery3PercentageThreshold1/Desired { "value": <DESIRED_BATTERY3_PERCENTAGE_THRESHOLD1>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery3PercentageThreshold1/Reported { "value": <REPORTED_BATTERY3_PERCENTAGE_THRESHOLD1>}

\subsection power_configuration_attr_battery3_percentage_threshold2 PowerConfiguration/Battery3PercentageThreshold2 Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/Battery3PercentageThreshold2/Reported
[PREFIX]/PowerConfiguration/Attributes/Battery3PercentageThreshold2/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster Battery3PercentageThreshold2 Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Battery3PercentageThreshold2 attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/Battery3PercentageThreshold2/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery3PercentageThreshold2/Desired { "value": <DESIRED_BATTERY3_PERCENTAGE_THRESHOLD2>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery3PercentageThreshold2/Reported { "value": <REPORTED_BATTERY3_PERCENTAGE_THRESHOLD2>}

\subsection power_configuration_attr_battery3_percentage_threshold3 PowerConfiguration/Battery3PercentageThreshold3 Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/Battery3PercentageThreshold3/Reported
[PREFIX]/PowerConfiguration/Attributes/Battery3PercentageThreshold3/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster Battery3PercentageThreshold3 Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Battery3PercentageThreshold3 attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/Battery3PercentageThreshold3/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery3PercentageThreshold3/Desired { "value": <DESIRED_BATTERY3_PERCENTAGE_THRESHOLD3>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery3PercentageThreshold3/Reported { "value": <REPORTED_BATTERY3_PERCENTAGE_THRESHOLD3>}

\subsection power_configuration_attr_battery3_alarm_state PowerConfiguration/Battery3AlarmState Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/Battery3AlarmState/Reported
[PREFIX]/PowerConfiguration/Attributes/Battery3AlarmState/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster Battery3AlarmState Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "BatteryAlarmState"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Battery3AlarmState attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PowerConfiguration/Attributes/Battery3AlarmState/+'

# Example output

ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery3AlarmState/Desired { "value": <DESIRED_BATTERY3_ALARM_STATE>}
ucl/by-unid/<UNID>/ep0/PowerConfiguration/Attributes/Battery3AlarmState/Reported { "value": <REPORTED_BATTERY3_ALARM_STATE>}

\subsection power_configuration_attr_cluster_revision PowerConfiguration/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Attributes/ClusterRevision/Reported
[PREFIX]/PowerConfiguration/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/PowerConfiguration/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/PowerConfiguration/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/PowerConfiguration/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section power_configuration_recv_cmd_support PowerConfiguration Command Support

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/SupportedCommands
[PREFIX]/PowerConfiguration/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for PowerConfiguration cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/PowerConfiguration/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/PowerConfiguration/SupportedCommands { "value": [] }

To see supported generated commands for PowerConfiguration cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/PowerConfiguration/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/PowerConfiguration/SupportedGeneratedCommands { "value": [] }

\section power_configuration_cmds PowerConfiguration Commands

\subsection power_configuration_write_attr_cmd PowerConfiguration/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
    "MainsAlarmMask": {
      "type": "PowerConfigurationMainsAlarmMask"
    },
    "MainsVoltageMinThreshold": {
      "type": "integer"
    },
    "MainsVoltageMaxThreshold": {
      "type": "integer"
    },
    "MainsVoltageDwellTripPoint": {
      "type": "integer"
    },
    "BatteryManufacturer": {
      "type": "string"
    },
    "BatterySize": {
      "type": "BatterySize"
    },
    "BatteryAHrRating": {
      "type": "integer"
    },
    "BatteryQuantity": {
      "type": "integer"
    },
    "BatteryRatedVoltage": {
      "type": "integer"
    },
    "BatteryAlarmMask": {
      "type": "BatteryAlarmMask"
    },
    "BatteryVoltageMinThreshold": {
      "type": "integer"
    },
    "BatteryVoltageThreshold1": {
      "type": "integer"
    },
    "BatteryVoltageThreshold2": {
      "type": "integer"
    },
    "BatteryVoltageThreshold3": {
      "type": "integer"
    },
    "BatteryPercentageMinThreshold": {
      "type": "integer"
    },
    "BatteryPercentageThreshold1": {
      "type": "integer"
    },
    "BatteryPercentageThreshold2": {
      "type": "integer"
    },
    "BatteryPercentageThreshold3": {
      "type": "integer"
    },
    "Battery2Manufacturer": {
      "type": "string"
    },
    "Battery2Size": {
      "type": "BatterySize"
    },
    "Battery2AHrRating": {
      "type": "integer"
    },
    "Battery2Quantity": {
      "type": "integer"
    },
    "Battery2RatedVoltage": {
      "type": "integer"
    },
    "Battery2AlarmMask": {
      "type": "BatteryAlarmMask"
    },
    "Battery2VoltageMinThreshold": {
      "type": "integer"
    },
    "Battery2VoltageThreshold1": {
      "type": "integer"
    },
    "Battery2VoltageThreshold2": {
      "type": "integer"
    },
    "Battery2VoltageThreshold3": {
      "type": "integer"
    },
    "Battery2PercentageMinThreshold": {
      "type": "integer"
    },
    "Battery2PercentageThreshold1": {
      "type": "integer"
    },
    "Battery2PercentageThreshold2": {
      "type": "integer"
    },
    "Battery2PercentageThreshold3": {
      "type": "integer"
    },
    "Battery3Manufacturer": {
      "type": "string"
    },
    "Battery3Size": {
      "type": "BatterySize"
    },
    "Battery3AHrRating": {
      "type": "integer"
    },
    "Battery3Quantity": {
      "type": "integer"
    },
    "Battery3RatedVoltage": {
      "type": "integer"
    },
    "Battery3AlarmMask": {
      "type": "BatteryAlarmMask"
    },
    "Battery3VoltageMinThreshold": {
      "type": "integer"
    },
    "Battery3VoltageThreshold1": {
      "type": "integer"
    },
    "Battery3VoltageThreshold2": {
      "type": "integer"
    },
    "Battery3VoltageThreshold3": {
      "type": "integer"
    },
    "Battery3PercentageMinThreshold": {
      "type": "integer"
    },
    "Battery3PercentageThreshold1": {
      "type": "integer"
    },
    "Battery3PercentageThreshold2": {
      "type": "integer"
    },
    "Battery3PercentageThreshold3": {
      "type": "integer"
    },
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all PowerConfiguration attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/PowerConfiguration/Commands/WriteAttributes' -m  '{ "MainsAlarmMask": <MAINS_ALARM_MASK_VALUE> ,"MainsVoltageMinThreshold": <MAINS_VOLTAGE_MIN_THRESHOLD_VALUE> ,"MainsVoltageMaxThreshold": <MAINS_VOLTAGE_MAX_THRESHOLD_VALUE> ,"MainsVoltageDwellTripPoint": <MAINS_VOLTAGE_DWELL_TRIP_POINT_VALUE> ,"BatteryManufacturer": <BATTERY_MANUFACTURER_VALUE> ,"BatterySize": <BATTERY_SIZE_VALUE> ,"BatteryAHrRating": <BATTERYA_HR_RATING_VALUE> ,"BatteryQuantity": <BATTERY_QUANTITY_VALUE> ,"BatteryRatedVoltage": <BATTERY_RATED_VOLTAGE_VALUE> ,"BatteryAlarmMask": <BATTERY_ALARM_MASK_VALUE> ,"BatteryVoltageMinThreshold": <BATTERY_VOLTAGE_MIN_THRESHOLD_VALUE> ,"BatteryVoltageThreshold1": <BATTERY_VOLTAGE_THRESHOLD1_VALUE> ,"BatteryVoltageThreshold2": <BATTERY_VOLTAGE_THRESHOLD2_VALUE> ,"BatteryVoltageThreshold3": <BATTERY_VOLTAGE_THRESHOLD3_VALUE> ,"BatteryPercentageMinThreshold": <BATTERY_PERCENTAGE_MIN_THRESHOLD_VALUE> ,"BatteryPercentageThreshold1": <BATTERY_PERCENTAGE_THRESHOLD1_VALUE> ,"BatteryPercentageThreshold2": <BATTERY_PERCENTAGE_THRESHOLD2_VALUE> ,"BatteryPercentageThreshold3": <BATTERY_PERCENTAGE_THRESHOLD3_VALUE> ,"Battery2Manufacturer": <BATTERY2_MANUFACTURER_VALUE> ,"Battery2Size": <BATTERY2_SIZE_VALUE> ,"Battery2AHrRating": <BATTERY2A_HR_RATING_VALUE> ,"Battery2Quantity": <BATTERY2_QUANTITY_VALUE> ,"Battery2RatedVoltage": <BATTERY2_RATED_VOLTAGE_VALUE> ,"Battery2AlarmMask": <BATTERY2_ALARM_MASK_VALUE> ,"Battery2VoltageMinThreshold": <BATTERY2_VOLTAGE_MIN_THRESHOLD_VALUE> ,"Battery2VoltageThreshold1": <BATTERY2_VOLTAGE_THRESHOLD1_VALUE> ,"Battery2VoltageThreshold2": <BATTERY2_VOLTAGE_THRESHOLD2_VALUE> ,"Battery2VoltageThreshold3": <BATTERY2_VOLTAGE_THRESHOLD3_VALUE> ,"Battery2PercentageMinThreshold": <BATTERY2_PERCENTAGE_MIN_THRESHOLD_VALUE> ,"Battery2PercentageThreshold1": <BATTERY2_PERCENTAGE_THRESHOLD1_VALUE> ,"Battery2PercentageThreshold2": <BATTERY2_PERCENTAGE_THRESHOLD2_VALUE> ,"Battery2PercentageThreshold3": <BATTERY2_PERCENTAGE_THRESHOLD3_VALUE> ,"Battery3Manufacturer": <BATTERY3_MANUFACTURER_VALUE> ,"Battery3Size": <BATTERY3_SIZE_VALUE> ,"Battery3AHrRating": <BATTERY3A_HR_RATING_VALUE> ,"Battery3Quantity": <BATTERY3_QUANTITY_VALUE> ,"Battery3RatedVoltage": <BATTERY3_RATED_VOLTAGE_VALUE> ,"Battery3AlarmMask": <BATTERY3_ALARM_MASK_VALUE> ,"Battery3VoltageMinThreshold": <BATTERY3_VOLTAGE_MIN_THRESHOLD_VALUE> ,"Battery3VoltageThreshold1": <BATTERY3_VOLTAGE_THRESHOLD1_VALUE> ,"Battery3VoltageThreshold2": <BATTERY3_VOLTAGE_THRESHOLD2_VALUE> ,"Battery3VoltageThreshold3": <BATTERY3_VOLTAGE_THRESHOLD3_VALUE> ,"Battery3PercentageMinThreshold": <BATTERY3_PERCENTAGE_MIN_THRESHOLD_VALUE> ,"Battery3PercentageThreshold1": <BATTERY3_PERCENTAGE_THRESHOLD1_VALUE> ,"Battery3PercentageThreshold2": <BATTERY3_PERCENTAGE_THRESHOLD2_VALUE> ,"Battery3PercentageThreshold3": <BATTERY3_PERCENTAGE_THRESHOLD3_VALUE> , }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection power_configuration_force_read_attr_cmd PowerConfiguration/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/PowerConfiguration/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfiguration Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "MainsVoltage",
          "MainsFrequency",
          "MainsAlarmMask",
          "MainsVoltageMinThreshold",
          "MainsVoltageMaxThreshold",
          "MainsVoltageDwellTripPoint",
          "BatteryVoltage",
          "BatteryPercentageRemaining",
          "BatteryManufacturer",
          "BatterySize",
          "BatteryAHrRating",
          "BatteryQuantity",
          "BatteryRatedVoltage",
          "BatteryAlarmMask",
          "BatteryVoltageMinThreshold",
          "BatteryVoltageThreshold1",
          "BatteryVoltageThreshold2",
          "BatteryVoltageThreshold3",
          "BatteryPercentageMinThreshold",
          "BatteryPercentageThreshold1",
          "BatteryPercentageThreshold2",
          "BatteryPercentageThreshold3",
          "BatteryAlarmState",
          "Battery2Voltage",
          "Battery2PercentageRemaining",
          "Battery2Manufacturer",
          "Battery2Size",
          "Battery2AHrRating",
          "Battery2Quantity",
          "Battery2RatedVoltage",
          "Battery2AlarmMask",
          "Battery2VoltageMinThreshold",
          "Battery2VoltageThreshold1",
          "Battery2VoltageThreshold2",
          "Battery2VoltageThreshold3",
          "Battery2PercentageMinThreshold",
          "Battery2PercentageThreshold1",
          "Battery2PercentageThreshold2",
          "Battery2PercentageThreshold3",
          "Battery2AlarmState",
          "Battery3Voltage",
          "Battery3PercentageRemaining",
          "Battery3Manufacturer",
          "Battery3Size",
          "Battery3AHrRating",
          "Battery3Quantity",
          "Battery3RatedVoltage",
          "Battery3AlarmMask",
          "Battery3VoltageMinThreshold",
          "Battery3VoltageThreshold1",
          "Battery3VoltageThreshold2",
          "Battery3VoltageThreshold3",
          "Battery3PercentageMinThreshold",
          "Battery3PercentageThreshold1",
          "Battery3PercentageThreshold2",
          "Battery3PercentageThreshold3",
          "Battery3AlarmState"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all PowerConfiguration attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/PowerConfiguration/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the PowerConfiguration attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/PowerConfiguration/Commands/ForceReadAttributes' -m  '{ "value": ["MainsVoltage"] }'

\page device_temperature_configuration DeviceTemperatureConfiguration Cluster The following commands and attributes are accepted as JSON payloads for the DeviceTemperatureConfiguration cluster.

\section device_temperature_configuration_attrs DeviceTemperatureConfiguration Attributes The following attribute topics are used to retrieve the DeviceTemperatureConfiguration cluster state.

\subsection device_temperature_configuration_attr_current_temperature DeviceTemperatureConfiguration/CurrentTemperature Attribute

MQTT Topic Pattern:

[PREFIX]/DeviceTemperatureConfiguration/Attributes/CurrentTemperature/Reported
[PREFIX]/DeviceTemperatureConfiguration/Attributes/CurrentTemperature/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DeviceTemperatureConfiguration Cluster CurrentTemperature Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CurrentTemperature attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DeviceTemperatureConfiguration/Attributes/CurrentTemperature/+'

# Example output

ucl/by-unid/<UNID>/ep0/DeviceTemperatureConfiguration/Attributes/CurrentTemperature/Desired { "value": <DESIRED_CURRENT_TEMPERATURE>}
ucl/by-unid/<UNID>/ep0/DeviceTemperatureConfiguration/Attributes/CurrentTemperature/Reported { "value": <REPORTED_CURRENT_TEMPERATURE>}

\subsection device_temperature_configuration_attr_min_temp_experienced DeviceTemperatureConfiguration/MinTempExperienced Attribute

MQTT Topic Pattern:

[PREFIX]/DeviceTemperatureConfiguration/Attributes/MinTempExperienced/Reported
[PREFIX]/DeviceTemperatureConfiguration/Attributes/MinTempExperienced/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DeviceTemperatureConfiguration Cluster MinTempExperienced Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MinTempExperienced attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DeviceTemperatureConfiguration/Attributes/MinTempExperienced/+'

# Example output

ucl/by-unid/<UNID>/ep0/DeviceTemperatureConfiguration/Attributes/MinTempExperienced/Desired { "value": <DESIRED_MIN_TEMP_EXPERIENCED>}
ucl/by-unid/<UNID>/ep0/DeviceTemperatureConfiguration/Attributes/MinTempExperienced/Reported { "value": <REPORTED_MIN_TEMP_EXPERIENCED>}

\subsection device_temperature_configuration_attr_max_temp_experienced DeviceTemperatureConfiguration/MaxTempExperienced Attribute

MQTT Topic Pattern:

[PREFIX]/DeviceTemperatureConfiguration/Attributes/MaxTempExperienced/Reported
[PREFIX]/DeviceTemperatureConfiguration/Attributes/MaxTempExperienced/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DeviceTemperatureConfiguration Cluster MaxTempExperienced Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MaxTempExperienced attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DeviceTemperatureConfiguration/Attributes/MaxTempExperienced/+'

# Example output

ucl/by-unid/<UNID>/ep0/DeviceTemperatureConfiguration/Attributes/MaxTempExperienced/Desired { "value": <DESIRED_MAX_TEMP_EXPERIENCED>}
ucl/by-unid/<UNID>/ep0/DeviceTemperatureConfiguration/Attributes/MaxTempExperienced/Reported { "value": <REPORTED_MAX_TEMP_EXPERIENCED>}

\subsection device_temperature_configuration_attr_over_temp_total_dwell DeviceTemperatureConfiguration/OverTempTotalDwell Attribute

MQTT Topic Pattern:

[PREFIX]/DeviceTemperatureConfiguration/Attributes/OverTempTotalDwell/Reported
[PREFIX]/DeviceTemperatureConfiguration/Attributes/OverTempTotalDwell/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DeviceTemperatureConfiguration Cluster OverTempTotalDwell Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for OverTempTotalDwell attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DeviceTemperatureConfiguration/Attributes/OverTempTotalDwell/+'

# Example output

ucl/by-unid/<UNID>/ep0/DeviceTemperatureConfiguration/Attributes/OverTempTotalDwell/Desired { "value": <DESIRED_OVER_TEMP_TOTAL_DWELL>}
ucl/by-unid/<UNID>/ep0/DeviceTemperatureConfiguration/Attributes/OverTempTotalDwell/Reported { "value": <REPORTED_OVER_TEMP_TOTAL_DWELL>}

\subsection device_temperature_configuration_attr_device_temp_alarm_mask DeviceTemperatureConfiguration/DeviceTempAlarmMask Attribute

MQTT Topic Pattern:

[PREFIX]/DeviceTemperatureConfiguration/Attributes/DeviceTempAlarmMask/Reported
[PREFIX]/DeviceTemperatureConfiguration/Attributes/DeviceTempAlarmMask/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DeviceTemperatureConfiguration Cluster DeviceTempAlarmMask Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "DeviceTemperatureConfigurationDeviceTempAlarmMask"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DeviceTempAlarmMask attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DeviceTemperatureConfiguration/Attributes/DeviceTempAlarmMask/+'

# Example output

ucl/by-unid/<UNID>/ep0/DeviceTemperatureConfiguration/Attributes/DeviceTempAlarmMask/Desired { "value": <DESIRED_DEVICE_TEMP_ALARM_MASK>}
ucl/by-unid/<UNID>/ep0/DeviceTemperatureConfiguration/Attributes/DeviceTempAlarmMask/Reported { "value": <REPORTED_DEVICE_TEMP_ALARM_MASK>}

\subsection device_temperature_configuration_attr_low_temp_threshold DeviceTemperatureConfiguration/LowTempThreshold Attribute

MQTT Topic Pattern:

[PREFIX]/DeviceTemperatureConfiguration/Attributes/LowTempThreshold/Reported
[PREFIX]/DeviceTemperatureConfiguration/Attributes/LowTempThreshold/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DeviceTemperatureConfiguration Cluster LowTempThreshold Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for LowTempThreshold attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DeviceTemperatureConfiguration/Attributes/LowTempThreshold/+'

# Example output

ucl/by-unid/<UNID>/ep0/DeviceTemperatureConfiguration/Attributes/LowTempThreshold/Desired { "value": <DESIRED_LOW_TEMP_THRESHOLD>}
ucl/by-unid/<UNID>/ep0/DeviceTemperatureConfiguration/Attributes/LowTempThreshold/Reported { "value": <REPORTED_LOW_TEMP_THRESHOLD>}

\subsection device_temperature_configuration_attr_high_temp_threshold DeviceTemperatureConfiguration/HighTempThreshold Attribute

MQTT Topic Pattern:

[PREFIX]/DeviceTemperatureConfiguration/Attributes/HighTempThreshold/Reported
[PREFIX]/DeviceTemperatureConfiguration/Attributes/HighTempThreshold/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DeviceTemperatureConfiguration Cluster HighTempThreshold Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for HighTempThreshold attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DeviceTemperatureConfiguration/Attributes/HighTempThreshold/+'

# Example output

ucl/by-unid/<UNID>/ep0/DeviceTemperatureConfiguration/Attributes/HighTempThreshold/Desired { "value": <DESIRED_HIGH_TEMP_THRESHOLD>}
ucl/by-unid/<UNID>/ep0/DeviceTemperatureConfiguration/Attributes/HighTempThreshold/Reported { "value": <REPORTED_HIGH_TEMP_THRESHOLD>}

\subsection device_temperature_configuration_attr_low_temp_dwell_trip_point DeviceTemperatureConfiguration/LowTempDwellTripPoint Attribute

MQTT Topic Pattern:

[PREFIX]/DeviceTemperatureConfiguration/Attributes/LowTempDwellTripPoint/Reported
[PREFIX]/DeviceTemperatureConfiguration/Attributes/LowTempDwellTripPoint/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DeviceTemperatureConfiguration Cluster LowTempDwellTripPoint Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for LowTempDwellTripPoint attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DeviceTemperatureConfiguration/Attributes/LowTempDwellTripPoint/+'

# Example output

ucl/by-unid/<UNID>/ep0/DeviceTemperatureConfiguration/Attributes/LowTempDwellTripPoint/Desired { "value": <DESIRED_LOW_TEMP_DWELL_TRIP_POINT>}
ucl/by-unid/<UNID>/ep0/DeviceTemperatureConfiguration/Attributes/LowTempDwellTripPoint/Reported { "value": <REPORTED_LOW_TEMP_DWELL_TRIP_POINT>}

\subsection device_temperature_configuration_attr_high_temp_dwell_trip_point DeviceTemperatureConfiguration/HighTempDwellTripPoint Attribute

MQTT Topic Pattern:

[PREFIX]/DeviceTemperatureConfiguration/Attributes/HighTempDwellTripPoint/Reported
[PREFIX]/DeviceTemperatureConfiguration/Attributes/HighTempDwellTripPoint/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DeviceTemperatureConfiguration Cluster HighTempDwellTripPoint Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for HighTempDwellTripPoint attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DeviceTemperatureConfiguration/Attributes/HighTempDwellTripPoint/+'

# Example output

ucl/by-unid/<UNID>/ep0/DeviceTemperatureConfiguration/Attributes/HighTempDwellTripPoint/Desired { "value": <DESIRED_HIGH_TEMP_DWELL_TRIP_POINT>}
ucl/by-unid/<UNID>/ep0/DeviceTemperatureConfiguration/Attributes/HighTempDwellTripPoint/Reported { "value": <REPORTED_HIGH_TEMP_DWELL_TRIP_POINT>}

\subsection device_temperature_configuration_attr_cluster_revision DeviceTemperatureConfiguration/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/DeviceTemperatureConfiguration/Attributes/ClusterRevision/Reported
[PREFIX]/DeviceTemperatureConfiguration/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DeviceTemperatureConfiguration Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DeviceTemperatureConfiguration/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/DeviceTemperatureConfiguration/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/DeviceTemperatureConfiguration/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section device_temperature_configuration_recv_cmd_support DeviceTemperatureConfiguration Command Support

MQTT Topic Pattern:

[PREFIX]/DeviceTemperatureConfiguration/SupportedCommands
[PREFIX]/DeviceTemperatureConfiguration/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DeviceTemperatureConfiguration Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for DeviceTemperatureConfiguration cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DeviceTemperatureConfiguration/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/DeviceTemperatureConfiguration/SupportedCommands { "value": [] }

To see supported generated commands for DeviceTemperatureConfiguration cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DeviceTemperatureConfiguration/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/DeviceTemperatureConfiguration/SupportedGeneratedCommands { "value": [] }

\section device_temperature_configuration_cmds DeviceTemperatureConfiguration Commands

\subsection device_temperature_configuration_write_attr_cmd DeviceTemperatureConfiguration/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/DeviceTemperatureConfiguration/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DeviceTemperatureConfiguration Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
    "DeviceTempAlarmMask": {
      "type": "DeviceTemperatureConfigurationDeviceTempAlarmMask"
    },
    "LowTempThreshold": {
      "type": "integer"
    },
    "HighTempThreshold": {
      "type": "integer"
    },
    "LowTempDwellTripPoint": {
      "type": "integer"
    },
    "HighTempDwellTripPoint": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all DeviceTemperatureConfiguration attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DeviceTemperatureConfiguration/Commands/WriteAttributes' -m  '{ "DeviceTempAlarmMask": <DEVICE_TEMP_ALARM_MASK_VALUE> ,"LowTempThreshold": <LOW_TEMP_THRESHOLD_VALUE> ,"HighTempThreshold": <HIGH_TEMP_THRESHOLD_VALUE> ,"LowTempDwellTripPoint": <LOW_TEMP_DWELL_TRIP_POINT_VALUE> ,"HighTempDwellTripPoint": <HIGH_TEMP_DWELL_TRIP_POINT_VALUE>  }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection device_temperature_configuration_force_read_attr_cmd DeviceTemperatureConfiguration/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/DeviceTemperatureConfiguration/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DeviceTemperatureConfiguration Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "CurrentTemperature",
          "MinTempExperienced",
          "MaxTempExperienced",
          "OverTempTotalDwell",
          "DeviceTempAlarmMask",
          "LowTempThreshold",
          "HighTempThreshold",
          "LowTempDwellTripPoint",
          "HighTempDwellTripPoint"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all DeviceTemperatureConfiguration attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DeviceTemperatureConfiguration/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the DeviceTemperatureConfiguration attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DeviceTemperatureConfiguration/Commands/ForceReadAttributes' -m  '{ "value": ["CurrentTemperature"] }'

\page identify Identify Cluster The following commands and attributes are accepted as JSON payloads for the Identify cluster.

\section identify_attrs Identify Attributes The following attribute topics are used to retrieve the Identify cluster state.

\subsection identify_attr_identify_time Identify/IdentifyTime Attribute

MQTT Topic Pattern:

[PREFIX]/Identify/Attributes/IdentifyTime/Reported
[PREFIX]/Identify/Attributes/IdentifyTime/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Identify Cluster IdentifyTime Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for IdentifyTime attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Identify/Attributes/IdentifyTime/+'

# Example output

ucl/by-unid/<UNID>/ep0/Identify/Attributes/IdentifyTime/Desired { "value": <DESIRED_IDENTIFY_TIME>}
ucl/by-unid/<UNID>/ep0/Identify/Attributes/IdentifyTime/Reported { "value": <REPORTED_IDENTIFY_TIME>}

\subsection identify_attr_cluster_revision Identify/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/Identify/Attributes/ClusterRevision/Reported
[PREFIX]/Identify/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Identify Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Identify/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/Identify/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/Identify/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section identify_recv_cmd_support Identify Command Support

MQTT Topic Pattern:

[PREFIX]/Identify/SupportedCommands
[PREFIX]/Identify/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Identify Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
              "Identify",
              "IdentifyQueryResponse",
              "IdentifyQuery",
              "TriggerEffect",
              "WriteAttributes",
              "ForceReadAttributes"
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for Identify cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Identify/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/Identify/SupportedCommands { "value": ["Identify","IdentifyQuery","TriggerEffect","WriteAttributes", "ForceReadAttributes"] }

To see supported generated commands for Identify cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Identify/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/Identify/SupportedGeneratedCommands { "value": ["IdentifyQueryResponse",] }

\section identify_cmds Identify Commands

\subsection identify_identify_cmd Identify/Identify Command

MQTT Topic Pattern:

[PREFIX]/Identify/Commands/Identify
[PREFIX]/Identify/GeneratedCommands/Identify

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Identify Cluster Identify Command Properties",
  "type": "object",
  "properties": {
    "IdentifyTime": {
      "type": "integer"
    }
  },
  "required": [
    "IdentifyTime"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Identify/Identify command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Identify/Commands/Identify' -m  '{ "IdentifyTime": <IDENTIFY_TIME_VALUE> }'

To receive a Identify/Identify generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Identify/GeneratedCommands/Identify'

\subsection identify_identify_query_response_cmd Identify/IdentifyQueryResponse Command

MQTT Topic Pattern:

[PREFIX]/Identify/Commands/IdentifyQueryResponse
[PREFIX]/Identify/GeneratedCommands/IdentifyQueryResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Identify Cluster IdentifyQueryResponse Command Properties",
  "type": "object",
  "properties": {
    "Timeout": {
      "type": "integer"
    }
  },
  "required": [
    "Timeout"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Identify/IdentifyQueryResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Identify/Commands/IdentifyQueryResponse' -m  '{ "Timeout": <TIMEOUT_VALUE> }'

To receive a Identify/IdentifyQueryResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Identify/GeneratedCommands/IdentifyQueryResponse'

\subsection identify_identify_query_cmd Identify/IdentifyQuery Command

MQTT Topic Pattern:

[PREFIX]/Identify/Commands/IdentifyQuery
[PREFIX]/Identify/GeneratedCommands/IdentifyQuery

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Identify Cluster IdentifyQuery Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
  ]
}

Example Mosquitto CLI Tool Usage

To send a Identify/IdentifyQuery command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Identify/Commands/IdentifyQuery' -m  '{  }'

To receive a Identify/IdentifyQuery generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Identify/GeneratedCommands/IdentifyQuery'

\subsection identify_trigger_effect_cmd Identify/TriggerEffect Command

MQTT Topic Pattern:

[PREFIX]/Identify/Commands/TriggerEffect
[PREFIX]/Identify/GeneratedCommands/TriggerEffect

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Identify Cluster TriggerEffect Command Properties",
  "type": "object",
  "properties": {
    "EffectIdentifier": {
      "type": "TriggerEffectEffectIdentifier"
    },
    "EffectVariant": {
      "type": "TriggerEffectEffectVariant"
    }
  },
  "required": [
    "EffectIdentifier",
    "EffectVariant"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Identify/TriggerEffect command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Identify/Commands/TriggerEffect' -m  '{ "EffectIdentifier": <EFFECT_IDENTIFIER_VALUE>,"EffectVariant": <EFFECT_VARIANT_VALUE> }'

To receive a Identify/TriggerEffect generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Identify/GeneratedCommands/TriggerEffect'

\subsection identify_write_attr_cmd Identify/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/Identify/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Identify Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
    "IdentifyTime": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all Identify attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Identify/Commands/WriteAttributes' -m  '{ "IdentifyTime": <IDENTIFY_TIME_VALUE>  }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection identify_force_read_attr_cmd Identify/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/Identify/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Identify Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "IdentifyTime"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all Identify attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Identify/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the Identify attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Identify/Commands/ForceReadAttributes' -m  '{ "value": ["IdentifyTime"] }'

\page groups Groups Cluster The following commands and attributes are accepted as JSON payloads for the Groups cluster.

\section groups_attrs Groups Attributes The following attribute topics are used to retrieve the Groups cluster state.

\subsection groups_attr_name_support Groups/NameSupport Attribute

MQTT Topic Pattern:

[PREFIX]/Groups/Attributes/NameSupport/Reported
[PREFIX]/Groups/Attributes/NameSupport/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Groups Cluster NameSupport Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "GroupsNameSupport"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for NameSupport attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Groups/Attributes/NameSupport/+'

# Example output

ucl/by-unid/<UNID>/ep0/Groups/Attributes/NameSupport/Desired { "value": <DESIRED_NAME_SUPPORT>}
ucl/by-unid/<UNID>/ep0/Groups/Attributes/NameSupport/Reported { "value": <REPORTED_NAME_SUPPORT>}

\subsection groups_attr_cluster_revision Groups/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/Groups/Attributes/ClusterRevision/Reported
[PREFIX]/Groups/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Groups Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Groups/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/Groups/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/Groups/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section groups_recv_cmd_support Groups Command Support

MQTT Topic Pattern:

[PREFIX]/Groups/SupportedCommands
[PREFIX]/Groups/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Groups Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
              "AddGroup",
              "AddGroupResponse",
              "ViewGroup",
              "ViewGroupResponse",
              "GetGroupMembership",
              "GetGroupMembershipResponse",
              "RemoveGroup",
              "RemoveGroupResponse",
              "RemoveAllGroups",
              "AddGroupIfIdentifying",
              "WriteAttributes",
              "ForceReadAttributes"
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for Groups cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Groups/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/Groups/SupportedCommands { "value": ["AddGroup","ViewGroup","GetGroupMembership","RemoveGroup","RemoveAllGroups","AddGroupIfIdentifying","WriteAttributes", "ForceReadAttributes"] }

To see supported generated commands for Groups cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Groups/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/Groups/SupportedGeneratedCommands { "value": ["AddGroupResponse","ViewGroupResponse","GetGroupMembershipResponse","RemoveGroupResponse",] }

\section groups_cmds Groups Commands

\subsection groups_add_group_cmd Groups/AddGroup Command

MQTT Topic Pattern:

[PREFIX]/Groups/Commands/AddGroup
[PREFIX]/Groups/GeneratedCommands/AddGroup

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Groups Cluster AddGroup Command Properties",
  "type": "object",
  "properties": {
    "GroupId": {
      "type": "integer"
    },
    "GroupName": {
      "type": "string"
    }
  },
  "required": [
    "GroupId",
    "GroupName"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Groups/AddGroup command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Groups/Commands/AddGroup' -m  '{ "GroupId": <GROUP_ID_VALUE>,"GroupName": <GROUP_NAME_VALUE> }'

To receive a Groups/AddGroup generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Groups/GeneratedCommands/AddGroup'

\subsection groups_add_group_response_cmd Groups/AddGroupResponse Command

MQTT Topic Pattern:

[PREFIX]/Groups/Commands/AddGroupResponse
[PREFIX]/Groups/GeneratedCommands/AddGroupResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Groups Cluster AddGroupResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "AddGroupResponseStatus"
    },
    "GroupId": {
      "type": "integer"
    }
  },
  "required": [
    "Status",
    "GroupId"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Groups/AddGroupResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Groups/Commands/AddGroupResponse' -m  '{ "Status": <STATUS_VALUE>,"GroupId": <GROUP_ID_VALUE> }'

To receive a Groups/AddGroupResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Groups/GeneratedCommands/AddGroupResponse'

\subsection groups_view_group_cmd Groups/ViewGroup Command

MQTT Topic Pattern:

[PREFIX]/Groups/Commands/ViewGroup
[PREFIX]/Groups/GeneratedCommands/ViewGroup

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Groups Cluster ViewGroup Command Properties",
  "type": "object",
  "properties": {
    "GroupId": {
      "type": "integer"
    }
  },
  "required": [
    "GroupId"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Groups/ViewGroup command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Groups/Commands/ViewGroup' -m  '{ "GroupId": <GROUP_ID_VALUE> }'

To receive a Groups/ViewGroup generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Groups/GeneratedCommands/ViewGroup'

\subsection groups_view_group_response_cmd Groups/ViewGroupResponse Command

MQTT Topic Pattern:

[PREFIX]/Groups/Commands/ViewGroupResponse
[PREFIX]/Groups/GeneratedCommands/ViewGroupResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Groups Cluster ViewGroupResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "ViewGroupResponseStatus"
    },
    "GroupId": {
      "type": "integer"
    },
    "GroupName": {
      "type": "string"
    }
  },
  "required": [
    "Status",
    "GroupId",
    "GroupName"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Groups/ViewGroupResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Groups/Commands/ViewGroupResponse' -m  '{ "Status": <STATUS_VALUE>,"GroupId": <GROUP_ID_VALUE>,"GroupName": <GROUP_NAME_VALUE> }'

To receive a Groups/ViewGroupResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Groups/GeneratedCommands/ViewGroupResponse'

\subsection groups_get_group_membership_cmd Groups/GetGroupMembership Command

MQTT Topic Pattern:

[PREFIX]/Groups/Commands/GetGroupMembership
[PREFIX]/Groups/GeneratedCommands/GetGroupMembership

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Groups Cluster GetGroupMembership Command Properties",
  "type": "object",
  "properties": {
    "GroupList": {
      "type": "array",
      "items": {
        "type": "integer"
      }

  },
  "required": [
    "GroupList"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Groups/GetGroupMembership command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Groups/Commands/GetGroupMembership' -m  '{ "GroupList": <GROUP_LIST_VALUE> }'

To receive a Groups/GetGroupMembership generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Groups/GeneratedCommands/GetGroupMembership'

\subsection groups_get_group_membership_response_cmd Groups/GetGroupMembershipResponse Command

MQTT Topic Pattern:

[PREFIX]/Groups/Commands/GetGroupMembershipResponse
[PREFIX]/Groups/GeneratedCommands/GetGroupMembershipResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Groups Cluster GetGroupMembershipResponse Command Properties",
  "type": "object",
  "properties": {
    "Capacity": {
      "type": "integer"
    },
    "GroupList": {
      "type": "array",
      "items": {
        "type": "integer"
      }

  },
  "required": [
    "Capacity",
    "GroupList"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Groups/GetGroupMembershipResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Groups/Commands/GetGroupMembershipResponse' -m  '{ "Capacity": <CAPACITY_VALUE>,"GroupList": <GROUP_LIST_VALUE> }'

To receive a Groups/GetGroupMembershipResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Groups/GeneratedCommands/GetGroupMembershipResponse'

\subsection groups_remove_group_cmd Groups/RemoveGroup Command

MQTT Topic Pattern:

[PREFIX]/Groups/Commands/RemoveGroup
[PREFIX]/Groups/GeneratedCommands/RemoveGroup

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Groups Cluster RemoveGroup Command Properties",
  "type": "object",
  "properties": {
    "GroupId": {
      "type": "integer"
    }
  },
  "required": [
    "GroupId"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Groups/RemoveGroup command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Groups/Commands/RemoveGroup' -m  '{ "GroupId": <GROUP_ID_VALUE> }'

To receive a Groups/RemoveGroup generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Groups/GeneratedCommands/RemoveGroup'

\subsection groups_remove_group_response_cmd Groups/RemoveGroupResponse Command

MQTT Topic Pattern:

[PREFIX]/Groups/Commands/RemoveGroupResponse
[PREFIX]/Groups/GeneratedCommands/RemoveGroupResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Groups Cluster RemoveGroupResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "RemoveGroupResponseStatus"
    },
    "GroupId": {
      "type": "integer"
    }
  },
  "required": [
    "Status",
    "GroupId"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Groups/RemoveGroupResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Groups/Commands/RemoveGroupResponse' -m  '{ "Status": <STATUS_VALUE>,"GroupId": <GROUP_ID_VALUE> }'

To receive a Groups/RemoveGroupResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Groups/GeneratedCommands/RemoveGroupResponse'

\subsection groups_remove_all_groups_cmd Groups/RemoveAllGroups Command

MQTT Topic Pattern:

[PREFIX]/Groups/Commands/RemoveAllGroups
[PREFIX]/Groups/GeneratedCommands/RemoveAllGroups

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Groups Cluster RemoveAllGroups Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
  ]
}

Example Mosquitto CLI Tool Usage

To send a Groups/RemoveAllGroups command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Groups/Commands/RemoveAllGroups' -m  '{  }'

To receive a Groups/RemoveAllGroups generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Groups/GeneratedCommands/RemoveAllGroups'

\subsection groups_add_group_if_identifying_cmd Groups/AddGroupIfIdentifying Command

MQTT Topic Pattern:

[PREFIX]/Groups/Commands/AddGroupIfIdentifying
[PREFIX]/Groups/GeneratedCommands/AddGroupIfIdentifying

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Groups Cluster AddGroupIfIdentifying Command Properties",
  "type": "object",
  "properties": {
    "GroupId": {
      "type": "integer"
    },
    "GroupName": {
      "type": "string"
    }
  },
  "required": [
    "GroupId",
    "GroupName"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Groups/AddGroupIfIdentifying command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Groups/Commands/AddGroupIfIdentifying' -m  '{ "GroupId": <GROUP_ID_VALUE>,"GroupName": <GROUP_NAME_VALUE> }'

To receive a Groups/AddGroupIfIdentifying generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Groups/GeneratedCommands/AddGroupIfIdentifying'

\subsection groups_write_attr_cmd Groups/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/Groups/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Groups Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all Groups attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Groups/Commands/WriteAttributes' -m  '{  }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection groups_force_read_attr_cmd Groups/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/Groups/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Groups Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "NameSupport"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all Groups attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Groups/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the Groups attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Groups/Commands/ForceReadAttributes' -m  '{ "value": ["NameSupport"] }'

\page scenes Scenes Cluster The following commands and attributes are accepted as JSON payloads for the Scenes cluster.

\section scenes_attrs Scenes Attributes The following attribute topics are used to retrieve the Scenes cluster state.

\subsection scenes_attr_scene_count Scenes/SceneCount Attribute

MQTT Topic Pattern:

[PREFIX]/Scenes/Attributes/SceneCount/Reported
[PREFIX]/Scenes/Attributes/SceneCount/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Scenes Cluster SceneCount Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for SceneCount attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Scenes/Attributes/SceneCount/+'

# Example output

ucl/by-unid/<UNID>/ep0/Scenes/Attributes/SceneCount/Desired { "value": <DESIRED_SCENE_COUNT>}
ucl/by-unid/<UNID>/ep0/Scenes/Attributes/SceneCount/Reported { "value": <REPORTED_SCENE_COUNT>}

\subsection scenes_attr_current_scene Scenes/CurrentScene Attribute

MQTT Topic Pattern:

[PREFIX]/Scenes/Attributes/CurrentScene/Reported
[PREFIX]/Scenes/Attributes/CurrentScene/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Scenes Cluster CurrentScene Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CurrentScene attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Scenes/Attributes/CurrentScene/+'

# Example output

ucl/by-unid/<UNID>/ep0/Scenes/Attributes/CurrentScene/Desired { "value": <DESIRED_CURRENT_SCENE>}
ucl/by-unid/<UNID>/ep0/Scenes/Attributes/CurrentScene/Reported { "value": <REPORTED_CURRENT_SCENE>}

\subsection scenes_attr_current_group Scenes/CurrentGroup Attribute

MQTT Topic Pattern:

[PREFIX]/Scenes/Attributes/CurrentGroup/Reported
[PREFIX]/Scenes/Attributes/CurrentGroup/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Scenes Cluster CurrentGroup Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "SGroupId"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CurrentGroup attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Scenes/Attributes/CurrentGroup/+'

# Example output

ucl/by-unid/<UNID>/ep0/Scenes/Attributes/CurrentGroup/Desired { "value": <DESIRED_CURRENT_GROUP>}
ucl/by-unid/<UNID>/ep0/Scenes/Attributes/CurrentGroup/Reported { "value": <REPORTED_CURRENT_GROUP>}

\subsection scenes_attr_scene_valid Scenes/SceneValid Attribute

MQTT Topic Pattern:

[PREFIX]/Scenes/Attributes/SceneValid/Reported
[PREFIX]/Scenes/Attributes/SceneValid/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Scenes Cluster SceneValid Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "boolean"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for SceneValid attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Scenes/Attributes/SceneValid/+'

# Example output

ucl/by-unid/<UNID>/ep0/Scenes/Attributes/SceneValid/Desired { "value": <DESIRED_SCENE_VALID>}
ucl/by-unid/<UNID>/ep0/Scenes/Attributes/SceneValid/Reported { "value": <REPORTED_SCENE_VALID>}

\subsection scenes_attr_name_support Scenes/NameSupport Attribute

MQTT Topic Pattern:

[PREFIX]/Scenes/Attributes/NameSupport/Reported
[PREFIX]/Scenes/Attributes/NameSupport/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Scenes Cluster NameSupport Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ScenesNameSupport"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for NameSupport attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Scenes/Attributes/NameSupport/+'

# Example output

ucl/by-unid/<UNID>/ep0/Scenes/Attributes/NameSupport/Desired { "value": <DESIRED_NAME_SUPPORT>}
ucl/by-unid/<UNID>/ep0/Scenes/Attributes/NameSupport/Reported { "value": <REPORTED_NAME_SUPPORT>}

\subsection scenes_attr_last_configured_by Scenes/LastConfiguredBy Attribute

MQTT Topic Pattern:

[PREFIX]/Scenes/Attributes/LastConfiguredBy/Reported
[PREFIX]/Scenes/Attributes/LastConfiguredBy/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Scenes Cluster LastConfiguredBy Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "EUI64"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for LastConfiguredBy attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Scenes/Attributes/LastConfiguredBy/+'

# Example output

ucl/by-unid/<UNID>/ep0/Scenes/Attributes/LastConfiguredBy/Desired { "value": <DESIRED_LAST_CONFIGURED_BY>}
ucl/by-unid/<UNID>/ep0/Scenes/Attributes/LastConfiguredBy/Reported { "value": <REPORTED_LAST_CONFIGURED_BY>}

\subsection scenes_attr_scene_table Scenes/SceneTable Attribute

MQTT Topic Pattern:

[PREFIX]/Scenes/Attributes/SceneTable/Reported
[PREFIX]/Scenes/Attributes/SceneTable/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Scenes Cluster SceneTable Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "type": "SSceneTable"
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for SceneTable attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Scenes/Attributes/SceneTable/+'

# Example output

ucl/by-unid/<UNID>/ep0/Scenes/Attributes/SceneTable/Desired { "value": [<DESIRED_SCENE_TABLE>,<DESIRED_SCENE_TABLE>]}
ucl/by-unid/<UNID>/ep0/Scenes/Attributes/SceneTable/Reported { "value": [<REPORTED_SCENE_TABLE>,<REPORTED_SCENE_TABLE>]}

\subsection scenes_attr_cluster_revision Scenes/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/Scenes/Attributes/ClusterRevision/Reported
[PREFIX]/Scenes/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Scenes Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/Scenes/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/Scenes/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section scenes_recv_cmd_support Scenes Command Support

MQTT Topic Pattern:

[PREFIX]/Scenes/SupportedCommands
[PREFIX]/Scenes/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Scenes Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
              "AddScene",
              "AddSceneResponse",
              "ViewScene",
              "ViewSceneResponse",
              "RemoveScene",
              "RemoveSceneResponse",
              "RemoveAllScenes",
              "RemoveAllScenesResponse",
              "StoreScene",
              "StoreSceneResponse",
              "RecallScene",
              "GetSceneMembership",
              "GetSceneMembershipResponse",
              "EnhancedAddScene",
              "EnhancedAddSceneResponse",
              "EnhancedViewScene",
              "EnhancedViewSceneResponse",
              "CopyScene",
              "CopySceneResponse",
              "WriteAttributes",
              "ForceReadAttributes"
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for Scenes cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/Scenes/SupportedCommands { "value": ["AddScene","ViewScene","RemoveScene","RemoveAllScenes","StoreScene","RecallScene","GetSceneMembership","EnhancedAddScene","EnhancedViewScene","CopyScene",] }

To see supported generated commands for Scenes cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/Scenes/SupportedGeneratedCommands { "value": ["AddSceneResponse","ViewSceneResponse","RemoveSceneResponse","RemoveAllScenesResponse","StoreSceneResponse","GetSceneMembershipResponse","EnhancedAddSceneResponse","EnhancedViewSceneResponse","CopySceneResponse"] }

\section scenes_cmds Scenes Commands

\subsection scenes_add_scene_cmd Scenes/AddScene Command

MQTT Topic Pattern:

[PREFIX]/Scenes/Commands/AddScene
[PREFIX]/Scenes/GeneratedCommands/AddScene

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Scenes Cluster AddScene Command Properties",
  "type": "object",
  "properties": {
    "GroupID": {
      "type": "SGroupId"
    },
    "SceneID": {
      "type": "integer"
    },
    "TransitionTime": {
      "type": "integer"
    },
    "SceneName": {
      "type": "SSceneName"
    },
    "ExtensionFieldSets": {
      "type": "array",
      "items": {
        "type": "SExtensionFieldSetList"
      }
,
    "TransitionTime100ms": {
      "type": "integer"
    }
  },
  "required": [
    "GroupID",
    "SceneID",
    "TransitionTime",
    "SceneName",
    "ExtensionFieldSets",
    "TransitionTime100ms"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Scenes/AddScene command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Commands/AddScene' -m  '{ "GroupID": <GROUPID_VALUE>,"SceneID": <SCENEID_VALUE>,"TransitionTime": <TRANSITION_TIME_VALUE>,"SceneName": <SCENE_NAME_VALUE>,"ExtensionFieldSets": <EXTENSION_FIELD_SETS_VALUE>,"TransitionTime100ms": <TRANSITION_TIME100MS_VALUE> }'

To receive a Scenes/AddScene generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/GeneratedCommands/AddScene'

\subsection scenes_add_scene_response_cmd Scenes/AddSceneResponse Command

MQTT Topic Pattern:

[PREFIX]/Scenes/Commands/AddSceneResponse
[PREFIX]/Scenes/GeneratedCommands/AddSceneResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Scenes Cluster AddSceneResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "zclStatus"
    },
    "GroupID": {
      "type": "SGroupId"
    },
    "SceneID": {
      "type": "integer"
    }
  },
  "required": [
    "Status",
    "GroupID",
    "SceneID"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Scenes/AddSceneResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Commands/AddSceneResponse' -m  '{ "Status": <STATUS_VALUE>,"GroupID": <GROUPID_VALUE>,"SceneID": <SCENEID_VALUE> }'

To receive a Scenes/AddSceneResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/GeneratedCommands/AddSceneResponse'

\subsection scenes_view_scene_cmd Scenes/ViewScene Command

MQTT Topic Pattern:

[PREFIX]/Scenes/Commands/ViewScene
[PREFIX]/Scenes/GeneratedCommands/ViewScene

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Scenes Cluster ViewScene Command Properties",
  "type": "object",
  "properties": {
    "GroupID": {
      "type": "SGroupId"
    },
    "SceneID": {
      "type": "integer"
    }
  },
  "required": [
    "GroupID",
    "SceneID"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Scenes/ViewScene command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Commands/ViewScene' -m  '{ "GroupID": <GROUPID_VALUE>,"SceneID": <SCENEID_VALUE> }'

To receive a Scenes/ViewScene generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/GeneratedCommands/ViewScene'

\subsection scenes_view_scene_response_cmd Scenes/ViewSceneResponse Command

MQTT Topic Pattern:

[PREFIX]/Scenes/Commands/ViewSceneResponse
[PREFIX]/Scenes/GeneratedCommands/ViewSceneResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Scenes Cluster ViewSceneResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "zclStatus"
    },
    "GroupID": {
      "type": "SGroupId"
    },
    "SceneID": {
      "type": "integer"
    },
    "TransitionTime": {
      "type": "integer"
    },
    "SceneName": {
      "type": "SSceneName"
    },
    "ExtensionFieldSets": {
      "type": "array",
      "items": {
        "type": "SExtensionFieldSetList"
      }

  },
  "required": [
    "Status",
    "GroupID",
    "SceneID",
    "TransitionTime",
    "SceneName",
    "ExtensionFieldSets"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Scenes/ViewSceneResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Commands/ViewSceneResponse' -m  '{ "Status": <STATUS_VALUE>,"GroupID": <GROUPID_VALUE>,"SceneID": <SCENEID_VALUE>,"TransitionTime": <TRANSITION_TIME_VALUE>,"SceneName": <SCENE_NAME_VALUE>,"ExtensionFieldSets": <EXTENSION_FIELD_SETS_VALUE> }'

To receive a Scenes/ViewSceneResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/GeneratedCommands/ViewSceneResponse'

\subsection scenes_remove_scene_cmd Scenes/RemoveScene Command

MQTT Topic Pattern:

[PREFIX]/Scenes/Commands/RemoveScene
[PREFIX]/Scenes/GeneratedCommands/RemoveScene

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Scenes Cluster RemoveScene Command Properties",
  "type": "object",
  "properties": {
    "GroupID": {
      "type": "SGroupId"
    },
    "SceneID": {
      "type": "integer"
    }
  },
  "required": [
    "GroupID",
    "SceneID"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Scenes/RemoveScene command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Commands/RemoveScene' -m  '{ "GroupID": <GROUPID_VALUE>,"SceneID": <SCENEID_VALUE> }'

To receive a Scenes/RemoveScene generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/GeneratedCommands/RemoveScene'

\subsection scenes_remove_scene_response_cmd Scenes/RemoveSceneResponse Command

MQTT Topic Pattern:

[PREFIX]/Scenes/Commands/RemoveSceneResponse
[PREFIX]/Scenes/GeneratedCommands/RemoveSceneResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Scenes Cluster RemoveSceneResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "zclStatus"
    },
    "GroupID": {
      "type": "SGroupId"
    },
    "SceneID": {
      "type": "integer"
    }
  },
  "required": [
    "Status",
    "GroupID",
    "SceneID"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Scenes/RemoveSceneResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Commands/RemoveSceneResponse' -m  '{ "Status": <STATUS_VALUE>,"GroupID": <GROUPID_VALUE>,"SceneID": <SCENEID_VALUE> }'

To receive a Scenes/RemoveSceneResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/GeneratedCommands/RemoveSceneResponse'

\subsection scenes_remove_all_scenes_cmd Scenes/RemoveAllScenes Command

MQTT Topic Pattern:

[PREFIX]/Scenes/Commands/RemoveAllScenes
[PREFIX]/Scenes/GeneratedCommands/RemoveAllScenes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Scenes Cluster RemoveAllScenes Command Properties",
  "type": "object",
  "properties": {
    "GroupID": {
      "type": "SGroupId"
    }
  },
  "required": [
    "GroupID"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Scenes/RemoveAllScenes command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Commands/RemoveAllScenes' -m  '{ "GroupID": <GROUPID_VALUE> }'

To receive a Scenes/RemoveAllScenes generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/GeneratedCommands/RemoveAllScenes'

\subsection scenes_remove_all_scenes_response_cmd Scenes/RemoveAllScenesResponse Command

MQTT Topic Pattern:

[PREFIX]/Scenes/Commands/RemoveAllScenesResponse
[PREFIX]/Scenes/GeneratedCommands/RemoveAllScenesResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Scenes Cluster RemoveAllScenesResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "zclStatus"
    },
    "GroupID": {
      "type": "SGroupId"
    }
  },
  "required": [
    "Status",
    "GroupID"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Scenes/RemoveAllScenesResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Commands/RemoveAllScenesResponse' -m  '{ "Status": <STATUS_VALUE>,"GroupID": <GROUPID_VALUE> }'

To receive a Scenes/RemoveAllScenesResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/GeneratedCommands/RemoveAllScenesResponse'

\subsection scenes_store_scene_cmd Scenes/StoreScene Command

MQTT Topic Pattern:

[PREFIX]/Scenes/Commands/StoreScene
[PREFIX]/Scenes/GeneratedCommands/StoreScene

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Scenes Cluster StoreScene Command Properties",
  "type": "object",
  "properties": {
    "GroupID": {
      "type": "SGroupId"
    },
    "SceneID": {
      "type": "integer"
    }
  },
  "required": [
    "GroupID",
    "SceneID"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Scenes/StoreScene command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Commands/StoreScene' -m  '{ "GroupID": <GROUPID_VALUE>,"SceneID": <SCENEID_VALUE> }'

To receive a Scenes/StoreScene generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/GeneratedCommands/StoreScene'

\subsection scenes_store_scene_response_cmd Scenes/StoreSceneResponse Command

MQTT Topic Pattern:

[PREFIX]/Scenes/Commands/StoreSceneResponse
[PREFIX]/Scenes/GeneratedCommands/StoreSceneResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Scenes Cluster StoreSceneResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "zclStatus"
    },
    "GroupID": {
      "type": "SGroupId"
    },
    "SceneID": {
      "type": "integer"
    }
  },
  "required": [
    "Status",
    "GroupID",
    "SceneID"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Scenes/StoreSceneResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Commands/StoreSceneResponse' -m  '{ "Status": <STATUS_VALUE>,"GroupID": <GROUPID_VALUE>,"SceneID": <SCENEID_VALUE> }'

To receive a Scenes/StoreSceneResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/GeneratedCommands/StoreSceneResponse'

\subsection scenes_recall_scene_cmd Scenes/RecallScene Command

MQTT Topic Pattern:

[PREFIX]/Scenes/Commands/RecallScene
[PREFIX]/Scenes/GeneratedCommands/RecallScene

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Scenes Cluster RecallScene Command Properties",
  "type": "object",
  "properties": {
    "GroupID": {
      "type": "SGroupId"
    },
    "SceneID": {
      "type": "integer"
    },
    "TransitionTime": {
      "type": "integer"
    }
  },
  "required": [
    "GroupID",
    "SceneID",
    "TransitionTime"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Scenes/RecallScene command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Commands/RecallScene' -m  '{ "GroupID": <GROUPID_VALUE>,"SceneID": <SCENEID_VALUE>,"TransitionTime": <TRANSITION_TIME_VALUE> }'

To receive a Scenes/RecallScene generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/GeneratedCommands/RecallScene'

\subsection scenes_get_scene_membership_cmd Scenes/GetSceneMembership Command

MQTT Topic Pattern:

[PREFIX]/Scenes/Commands/GetSceneMembership
[PREFIX]/Scenes/GeneratedCommands/GetSceneMembership

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Scenes Cluster GetSceneMembership Command Properties",
  "type": "object",
  "properties": {
    "GroupID": {
      "type": "SGroupId"
    }
  },
  "required": [
    "GroupID"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Scenes/GetSceneMembership command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Commands/GetSceneMembership' -m  '{ "GroupID": <GROUPID_VALUE> }'

To receive a Scenes/GetSceneMembership generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/GeneratedCommands/GetSceneMembership'

\subsection scenes_get_scene_membership_response_cmd Scenes/GetSceneMembershipResponse Command

MQTT Topic Pattern:

[PREFIX]/Scenes/Commands/GetSceneMembershipResponse
[PREFIX]/Scenes/GeneratedCommands/GetSceneMembershipResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Scenes Cluster GetSceneMembershipResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "zclStatus"
    },
    "Capacity": {
      "type": "integer"
    },
    "GroupID": {
      "type": "SGroupId"
    },
    "SceneList": {
      "type": "array",
      "items": {
        "type": "integer"
      }

  },
  "required": [
    "Status",
    "Capacity",
    "GroupID",
    "SceneList"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Scenes/GetSceneMembershipResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Commands/GetSceneMembershipResponse' -m  '{ "Status": <STATUS_VALUE>,"Capacity": <CAPACITY_VALUE>,"GroupID": <GROUPID_VALUE>,"SceneList": <SCENE_LIST_VALUE> }'

To receive a Scenes/GetSceneMembershipResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/GeneratedCommands/GetSceneMembershipResponse'

\subsection scenes_enhanced_add_scene_cmd Scenes/EnhancedAddScene Command

MQTT Topic Pattern:

[PREFIX]/Scenes/Commands/EnhancedAddScene
[PREFIX]/Scenes/GeneratedCommands/EnhancedAddScene

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Scenes Cluster EnhancedAddScene Command Properties",
  "type": "object",
  "properties": {
    "GroupID": {
      "type": "SGroupId"
    },
    "SceneID": {
      "type": "integer"
    },
    "TransitionTime": {
      "type": "integer"
    },
    "SceneName": {
      "type": "SSceneName"
    },
    "ExtensionFieldSets": {
      "type": "array",
      "items": {
        "type": "SExtensionFieldSetList"
      }

  },
  "required": [
    "GroupID",
    "SceneID",
    "TransitionTime",
    "SceneName",
    "ExtensionFieldSets"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Scenes/EnhancedAddScene command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Commands/EnhancedAddScene' -m  '{ "GroupID": <GROUPID_VALUE>,"SceneID": <SCENEID_VALUE>,"TransitionTime": <TRANSITION_TIME_VALUE>,"SceneName": <SCENE_NAME_VALUE>,"ExtensionFieldSets": <EXTENSION_FIELD_SETS_VALUE> }'

To receive a Scenes/EnhancedAddScene generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/GeneratedCommands/EnhancedAddScene'

\subsection scenes_enhanced_add_scene_response_cmd Scenes/EnhancedAddSceneResponse Command

MQTT Topic Pattern:

[PREFIX]/Scenes/Commands/EnhancedAddSceneResponse
[PREFIX]/Scenes/GeneratedCommands/EnhancedAddSceneResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Scenes Cluster EnhancedAddSceneResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "zclStatus"
    },
    "GroupID": {
      "type": "SGroupId"
    },
    "SceneID": {
      "type": "integer"
    }
  },
  "required": [
    "Status",
    "GroupID",
    "SceneID"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Scenes/EnhancedAddSceneResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Commands/EnhancedAddSceneResponse' -m  '{ "Status": <STATUS_VALUE>,"GroupID": <GROUPID_VALUE>,"SceneID": <SCENEID_VALUE> }'

To receive a Scenes/EnhancedAddSceneResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/GeneratedCommands/EnhancedAddSceneResponse'

\subsection scenes_enhanced_view_scene_cmd Scenes/EnhancedViewScene Command

MQTT Topic Pattern:

[PREFIX]/Scenes/Commands/EnhancedViewScene
[PREFIX]/Scenes/GeneratedCommands/EnhancedViewScene

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Scenes Cluster EnhancedViewScene Command Properties",
  "type": "object",
  "properties": {
    "GroupID": {
      "type": "SGroupId"
    },
    "SceneID": {
      "type": "integer"
    }
  },
  "required": [
    "GroupID",
    "SceneID"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Scenes/EnhancedViewScene command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Commands/EnhancedViewScene' -m  '{ "GroupID": <GROUPID_VALUE>,"SceneID": <SCENEID_VALUE> }'

To receive a Scenes/EnhancedViewScene generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/GeneratedCommands/EnhancedViewScene'

\subsection scenes_enhanced_view_scene_response_cmd Scenes/EnhancedViewSceneResponse Command

MQTT Topic Pattern:

[PREFIX]/Scenes/Commands/EnhancedViewSceneResponse
[PREFIX]/Scenes/GeneratedCommands/EnhancedViewSceneResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Scenes Cluster EnhancedViewSceneResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "zclStatus"
    },
    "GroupID": {
      "type": "SGroupId"
    },
    "SceneID": {
      "type": "integer"
    },
    "TransitionTime": {
      "type": "integer"
    },
    "SceneName": {
      "type": "SSceneName"
    },
    "ExtensionFieldSets": {
      "type": "array",
      "items": {
        "type": "SExtensionFieldSetList"
      }

  },
  "required": [
    "Status",
    "GroupID",
    "SceneID",
    "TransitionTime",
    "SceneName",
    "ExtensionFieldSets"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Scenes/EnhancedViewSceneResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Commands/EnhancedViewSceneResponse' -m  '{ "Status": <STATUS_VALUE>,"GroupID": <GROUPID_VALUE>,"SceneID": <SCENEID_VALUE>,"TransitionTime": <TRANSITION_TIME_VALUE>,"SceneName": <SCENE_NAME_VALUE>,"ExtensionFieldSets": <EXTENSION_FIELD_SETS_VALUE> }'

To receive a Scenes/EnhancedViewSceneResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/GeneratedCommands/EnhancedViewSceneResponse'

\subsection scenes_copy_scene_cmd Scenes/CopyScene Command

MQTT Topic Pattern:

[PREFIX]/Scenes/Commands/CopyScene
[PREFIX]/Scenes/GeneratedCommands/CopyScene

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Scenes Cluster CopyScene Command Properties",
  "type": "object",
  "properties": {
    "Mode": {
      "type": "CopySceneMode"
    },
    "GroupIdentifierFrom": {
      "type": "SGroupId"
    },
    "SceneIdentifierFrom": {
      "type": "integer"
    },
    "GroupIdentifierTo": {
      "type": "SGroupId"
    },
    "SceneIdentifierTo": {
      "type": "integer"
    }
  },
  "required": [
    "Mode",
    "GroupIdentifierFrom",
    "SceneIdentifierFrom",
    "GroupIdentifierTo",
    "SceneIdentifierTo"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Scenes/CopyScene command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Commands/CopyScene' -m  '{ "Mode": <MODE_VALUE>,"GroupIdentifierFrom": <GROUP_IDENTIFIER_FROM_VALUE>,"SceneIdentifierFrom": <SCENE_IDENTIFIER_FROM_VALUE>,"GroupIdentifierTo": <GROUP_IDENTIFIER_TO_VALUE>,"SceneIdentifierTo": <SCENE_IDENTIFIER_TO_VALUE> }'

To receive a Scenes/CopyScene generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/GeneratedCommands/CopyScene'

\subsection scenes_copy_scene_response_cmd Scenes/CopySceneResponse Command

MQTT Topic Pattern:

[PREFIX]/Scenes/Commands/CopySceneResponse
[PREFIX]/Scenes/GeneratedCommands/CopySceneResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Scenes Cluster CopySceneResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "zclStatus"
    },
    "GroupIdentifierFrom": {
      "type": "SGroupId"
    },
    "SceneIdentifierFrom": {
      "type": "integer"
    }
  },
  "required": [
    "Status",
    "GroupIdentifierFrom",
    "SceneIdentifierFrom"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Scenes/CopySceneResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Commands/CopySceneResponse' -m  '{ "Status": <STATUS_VALUE>,"GroupIdentifierFrom": <GROUP_IDENTIFIER_FROM_VALUE>,"SceneIdentifierFrom": <SCENE_IDENTIFIER_FROM_VALUE> }'

To receive a Scenes/CopySceneResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/GeneratedCommands/CopySceneResponse'

\subsection scenes_write_attr_cmd Scenes/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/Scenes/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Scenes Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all Scenes attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Commands/WriteAttributes' -m  '{  }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection scenes_force_read_attr_cmd Scenes/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/Scenes/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Scenes Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "SceneCount",
          "CurrentScene",
          "CurrentGroup",
          "SceneValid",
          "NameSupport",
          "LastConfiguredBy",
          "SceneTable"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all Scenes attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the Scenes attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Commands/ForceReadAttributes' -m  '{ "value": ["SceneCount"] }'

\page on_off OnOff Cluster The following commands and attributes are accepted as JSON payloads for the OnOff cluster.

\section on_off_attrs OnOff Attributes The following attribute topics are used to retrieve the OnOff cluster state.

\subsection on_off_attr_on_off OnOff/OnOff Attribute

MQTT Topic Pattern:

[PREFIX]/OnOff/Attributes/OnOff/Reported
[PREFIX]/OnOff/Attributes/OnOff/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "OnOff Cluster OnOff Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "boolean"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for OnOff attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/OnOff/Attributes/OnOff/+'

# Example output

ucl/by-unid/<UNID>/ep0/OnOff/Attributes/OnOff/Desired { "value": <DESIRED_ON_OFF>}
ucl/by-unid/<UNID>/ep0/OnOff/Attributes/OnOff/Reported { "value": <REPORTED_ON_OFF>}

\subsection on_off_attr_global_scene_control OnOff/GlobalSceneControl Attribute

MQTT Topic Pattern:

[PREFIX]/OnOff/Attributes/GlobalSceneControl/Reported
[PREFIX]/OnOff/Attributes/GlobalSceneControl/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "OnOff Cluster GlobalSceneControl Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "boolean"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for GlobalSceneControl attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/OnOff/Attributes/GlobalSceneControl/+'

# Example output

ucl/by-unid/<UNID>/ep0/OnOff/Attributes/GlobalSceneControl/Desired { "value": <DESIRED_GLOBAL_SCENE_CONTROL>}
ucl/by-unid/<UNID>/ep0/OnOff/Attributes/GlobalSceneControl/Reported { "value": <REPORTED_GLOBAL_SCENE_CONTROL>}

\subsection on_off_attr_on_time OnOff/OnTime Attribute

MQTT Topic Pattern:

[PREFIX]/OnOff/Attributes/OnTime/Reported
[PREFIX]/OnOff/Attributes/OnTime/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "OnOff Cluster OnTime Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for OnTime attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/OnOff/Attributes/OnTime/+'

# Example output

ucl/by-unid/<UNID>/ep0/OnOff/Attributes/OnTime/Desired { "value": <DESIRED_ON_TIME>}
ucl/by-unid/<UNID>/ep0/OnOff/Attributes/OnTime/Reported { "value": <REPORTED_ON_TIME>}

\subsection on_off_attr_off_wait_time OnOff/OffWaitTime Attribute

MQTT Topic Pattern:

[PREFIX]/OnOff/Attributes/OffWaitTime/Reported
[PREFIX]/OnOff/Attributes/OffWaitTime/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "OnOff Cluster OffWaitTime Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for OffWaitTime attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/OnOff/Attributes/OffWaitTime/+'

# Example output

ucl/by-unid/<UNID>/ep0/OnOff/Attributes/OffWaitTime/Desired { "value": <DESIRED_OFF_WAIT_TIME>}
ucl/by-unid/<UNID>/ep0/OnOff/Attributes/OffWaitTime/Reported { "value": <REPORTED_OFF_WAIT_TIME>}

\subsection on_off_attr_start_up_on_off OnOff/StartUpOnOff Attribute

MQTT Topic Pattern:

[PREFIX]/OnOff/Attributes/StartUpOnOff/Reported
[PREFIX]/OnOff/Attributes/StartUpOnOff/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "OnOff Cluster StartUpOnOff Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "OnOffStartUpOnOff"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for StartUpOnOff attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/OnOff/Attributes/StartUpOnOff/+'

# Example output

ucl/by-unid/<UNID>/ep0/OnOff/Attributes/StartUpOnOff/Desired { "value": <DESIRED_START_UP_ON_OFF>}
ucl/by-unid/<UNID>/ep0/OnOff/Attributes/StartUpOnOff/Reported { "value": <REPORTED_START_UP_ON_OFF>}

\subsection on_off_attr_cluster_revision OnOff/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/OnOff/Attributes/ClusterRevision/Reported
[PREFIX]/OnOff/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "OnOff Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/OnOff/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/OnOff/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/OnOff/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section on_off_recv_cmd_support OnOff Command Support

MQTT Topic Pattern:

[PREFIX]/OnOff/SupportedCommands
[PREFIX]/OnOff/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "OnOff Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
              "Off",
              "On",
              "Toggle",
              "OffWithEffect",
              "OnWithRecallGlobalScene",
              "OnWithTimedOff",
              "WriteAttributes",
              "ForceReadAttributes"
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for OnOff cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/OnOff/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/OnOff/SupportedCommands { "value": ["Off","On","Toggle","OffWithEffect","OnWithRecallGlobalScene","OnWithTimedOff","WriteAttributes", "ForceReadAttributes"] }

To see supported generated commands for OnOff cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/OnOff/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/OnOff/SupportedGeneratedCommands { "value": [] }

\section on_off_cmds OnOff Commands

\subsection on_off_off_cmd OnOff/Off Command

MQTT Topic Pattern:

[PREFIX]/OnOff/Commands/Off
[PREFIX]/OnOff/GeneratedCommands/Off

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "OnOff Cluster Off Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
  ]
}

Example Mosquitto CLI Tool Usage

To send a OnOff/Off command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/OnOff/Commands/Off' -m  '{  }'

To receive a OnOff/Off generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/OnOff/GeneratedCommands/Off'

\subsection on_off_on_cmd OnOff/On Command

MQTT Topic Pattern:

[PREFIX]/OnOff/Commands/On
[PREFIX]/OnOff/GeneratedCommands/On

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "OnOff Cluster On Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
  ]
}

Example Mosquitto CLI Tool Usage

To send a OnOff/On command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/OnOff/Commands/On' -m  '{  }'

To receive a OnOff/On generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/OnOff/GeneratedCommands/On'

\subsection on_off_toggle_cmd OnOff/Toggle Command

MQTT Topic Pattern:

[PREFIX]/OnOff/Commands/Toggle
[PREFIX]/OnOff/GeneratedCommands/Toggle

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "OnOff Cluster Toggle Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
  ]
}

Example Mosquitto CLI Tool Usage

To send a OnOff/Toggle command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/OnOff/Commands/Toggle' -m  '{  }'

To receive a OnOff/Toggle generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/OnOff/GeneratedCommands/Toggle'

\subsection on_off_off_with_effect_cmd OnOff/OffWithEffect Command

MQTT Topic Pattern:

[PREFIX]/OnOff/Commands/OffWithEffect
[PREFIX]/OnOff/GeneratedCommands/OffWithEffect

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "OnOff Cluster OffWithEffect Command Properties",
  "type": "object",
  "properties": {
    "EffectIdentifier": {
      "type": "OffWithEffectEffectIdentifier"
    },
    "EffectVariant": {
      "type": "integer"
    }
  },
  "required": [
    "EffectIdentifier",
    "EffectVariant"
  ]
}

Example Mosquitto CLI Tool Usage

To send a OnOff/OffWithEffect command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/OnOff/Commands/OffWithEffect' -m  '{ "EffectIdentifier": <EFFECT_IDENTIFIER_VALUE>,"EffectVariant": <EFFECT_VARIANT_VALUE> }'

To receive a OnOff/OffWithEffect generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/OnOff/GeneratedCommands/OffWithEffect'

\subsection on_off_on_with_recall_global_scene_cmd OnOff/OnWithRecallGlobalScene Command

MQTT Topic Pattern:

[PREFIX]/OnOff/Commands/OnWithRecallGlobalScene
[PREFIX]/OnOff/GeneratedCommands/OnWithRecallGlobalScene

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "OnOff Cluster OnWithRecallGlobalScene Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
  ]
}

Example Mosquitto CLI Tool Usage

To send a OnOff/OnWithRecallGlobalScene command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/OnOff/Commands/OnWithRecallGlobalScene' -m  '{  }'

To receive a OnOff/OnWithRecallGlobalScene generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/OnOff/GeneratedCommands/OnWithRecallGlobalScene'

\subsection on_off_on_with_timed_off_cmd OnOff/OnWithTimedOff Command

MQTT Topic Pattern:

[PREFIX]/OnOff/Commands/OnWithTimedOff
[PREFIX]/OnOff/GeneratedCommands/OnWithTimedOff

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "OnOff Cluster OnWithTimedOff Command Properties",
  "type": "object",
  "properties": {
    "OnOffControl": {
      "type": "OnWithTimedOffOnOffControl"
    },
    "OnTime": {
      "type": "integer"
    },
    "OffWaitTime": {
      "type": "integer"
    }
  },
  "required": [
    "OnOffControl",
    "OnTime",
    "OffWaitTime"
  ]
}

Example Mosquitto CLI Tool Usage

To send a OnOff/OnWithTimedOff command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/OnOff/Commands/OnWithTimedOff' -m  '{ "OnOffControl": <ON_OFF_CONTROL_VALUE>,"OnTime": <ON_TIME_VALUE>,"OffWaitTime": <OFF_WAIT_TIME_VALUE> }'

To receive a OnOff/OnWithTimedOff generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/OnOff/GeneratedCommands/OnWithTimedOff'

\subsection on_off_write_attr_cmd OnOff/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/OnOff/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "OnOff Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
    "OnTime": {
      "type": "integer"
    },
    "OffWaitTime": {
      "type": "integer"
    },
    "StartUpOnOff": {
      "type": "OnOffStartUpOnOff"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all OnOff attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/OnOff/Commands/WriteAttributes' -m  '{ "OnTime": <ON_TIME_VALUE> ,"OffWaitTime": <OFF_WAIT_TIME_VALUE> ,"StartUpOnOff": <START_UP_ON_OFF_VALUE>  }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection on_off_force_read_attr_cmd OnOff/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/OnOff/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "OnOff Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "OnOff",
          "GlobalSceneControl",
          "OnTime",
          "OffWaitTime",
          "StartUpOnOff"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all OnOff attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/OnOff/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the OnOff attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/OnOff/Commands/ForceReadAttributes' -m  '{ "value": ["OnOff"] }'

\page level Level Cluster The following commands and attributes are accepted as JSON payloads for the Level cluster.

\section level_attrs Level Attributes The following attribute topics are used to retrieve the Level cluster state.

\subsection level_attr_current_level Level/CurrentLevel Attribute

MQTT Topic Pattern:

[PREFIX]/Level/Attributes/CurrentLevel/Reported
[PREFIX]/Level/Attributes/CurrentLevel/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Level Cluster CurrentLevel Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CurrentLevel attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Level/Attributes/CurrentLevel/+'

# Example output

ucl/by-unid/<UNID>/ep0/Level/Attributes/CurrentLevel/Desired { "value": <DESIRED_CURRENT_LEVEL>}
ucl/by-unid/<UNID>/ep0/Level/Attributes/CurrentLevel/Reported { "value": <REPORTED_CURRENT_LEVEL>}

\subsection level_attr_remaining_time Level/RemainingTime Attribute

MQTT Topic Pattern:

[PREFIX]/Level/Attributes/RemainingTime/Reported
[PREFIX]/Level/Attributes/RemainingTime/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Level Cluster RemainingTime Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RemainingTime attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Level/Attributes/RemainingTime/+'

# Example output

ucl/by-unid/<UNID>/ep0/Level/Attributes/RemainingTime/Desired { "value": <DESIRED_REMAINING_TIME>}
ucl/by-unid/<UNID>/ep0/Level/Attributes/RemainingTime/Reported { "value": <REPORTED_REMAINING_TIME>}

\subsection level_attr_min_level Level/MinLevel Attribute

MQTT Topic Pattern:

[PREFIX]/Level/Attributes/MinLevel/Reported
[PREFIX]/Level/Attributes/MinLevel/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Level Cluster MinLevel Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MinLevel attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Level/Attributes/MinLevel/+'

# Example output

ucl/by-unid/<UNID>/ep0/Level/Attributes/MinLevel/Desired { "value": <DESIRED_MIN_LEVEL>}
ucl/by-unid/<UNID>/ep0/Level/Attributes/MinLevel/Reported { "value": <REPORTED_MIN_LEVEL>}

\subsection level_attr_max_level Level/MaxLevel Attribute

MQTT Topic Pattern:

[PREFIX]/Level/Attributes/MaxLevel/Reported
[PREFIX]/Level/Attributes/MaxLevel/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Level Cluster MaxLevel Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MaxLevel attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Level/Attributes/MaxLevel/+'

# Example output

ucl/by-unid/<UNID>/ep0/Level/Attributes/MaxLevel/Desired { "value": <DESIRED_MAX_LEVEL>}
ucl/by-unid/<UNID>/ep0/Level/Attributes/MaxLevel/Reported { "value": <REPORTED_MAX_LEVEL>}

\subsection level_attr_current_frequency Level/CurrentFrequency Attribute

MQTT Topic Pattern:

[PREFIX]/Level/Attributes/CurrentFrequency/Reported
[PREFIX]/Level/Attributes/CurrentFrequency/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Level Cluster CurrentFrequency Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CurrentFrequency attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Level/Attributes/CurrentFrequency/+'

# Example output

ucl/by-unid/<UNID>/ep0/Level/Attributes/CurrentFrequency/Desired { "value": <DESIRED_CURRENT_FREQUENCY>}
ucl/by-unid/<UNID>/ep0/Level/Attributes/CurrentFrequency/Reported { "value": <REPORTED_CURRENT_FREQUENCY>}

\subsection level_attr_min_frequency Level/MinFrequency Attribute

MQTT Topic Pattern:

[PREFIX]/Level/Attributes/MinFrequency/Reported
[PREFIX]/Level/Attributes/MinFrequency/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Level Cluster MinFrequency Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MinFrequency attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Level/Attributes/MinFrequency/+'

# Example output

ucl/by-unid/<UNID>/ep0/Level/Attributes/MinFrequency/Desired { "value": <DESIRED_MIN_FREQUENCY>}
ucl/by-unid/<UNID>/ep0/Level/Attributes/MinFrequency/Reported { "value": <REPORTED_MIN_FREQUENCY>}

\subsection level_attr_max_frequency Level/MaxFrequency Attribute

MQTT Topic Pattern:

[PREFIX]/Level/Attributes/MaxFrequency/Reported
[PREFIX]/Level/Attributes/MaxFrequency/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Level Cluster MaxFrequency Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MaxFrequency attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Level/Attributes/MaxFrequency/+'

# Example output

ucl/by-unid/<UNID>/ep0/Level/Attributes/MaxFrequency/Desired { "value": <DESIRED_MAX_FREQUENCY>}
ucl/by-unid/<UNID>/ep0/Level/Attributes/MaxFrequency/Reported { "value": <REPORTED_MAX_FREQUENCY>}

\subsection level_attr_options Level/Options Attribute

MQTT Topic Pattern:

[PREFIX]/Level/Attributes/Options/Reported
[PREFIX]/Level/Attributes/Options/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Level Cluster Options Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "LevelOptions"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Options attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Level/Attributes/Options/+'

# Example output

ucl/by-unid/<UNID>/ep0/Level/Attributes/Options/Desired { "value": <DESIRED_OPTIONS>}
ucl/by-unid/<UNID>/ep0/Level/Attributes/Options/Reported { "value": <REPORTED_OPTIONS>}

\subsection level_attr_on_off_transition_time Level/OnOffTransitionTime Attribute

MQTT Topic Pattern:

[PREFIX]/Level/Attributes/OnOffTransitionTime/Reported
[PREFIX]/Level/Attributes/OnOffTransitionTime/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Level Cluster OnOffTransitionTime Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for OnOffTransitionTime attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Level/Attributes/OnOffTransitionTime/+'

# Example output

ucl/by-unid/<UNID>/ep0/Level/Attributes/OnOffTransitionTime/Desired { "value": <DESIRED_ON_OFF_TRANSITION_TIME>}
ucl/by-unid/<UNID>/ep0/Level/Attributes/OnOffTransitionTime/Reported { "value": <REPORTED_ON_OFF_TRANSITION_TIME>}

\subsection level_attr_on_level Level/OnLevel Attribute

MQTT Topic Pattern:

[PREFIX]/Level/Attributes/OnLevel/Reported
[PREFIX]/Level/Attributes/OnLevel/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Level Cluster OnLevel Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for OnLevel attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Level/Attributes/OnLevel/+'

# Example output

ucl/by-unid/<UNID>/ep0/Level/Attributes/OnLevel/Desired { "value": <DESIRED_ON_LEVEL>}
ucl/by-unid/<UNID>/ep0/Level/Attributes/OnLevel/Reported { "value": <REPORTED_ON_LEVEL>}

\subsection level_attr_on_transition_time Level/OnTransitionTime Attribute

MQTT Topic Pattern:

[PREFIX]/Level/Attributes/OnTransitionTime/Reported
[PREFIX]/Level/Attributes/OnTransitionTime/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Level Cluster OnTransitionTime Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for OnTransitionTime attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Level/Attributes/OnTransitionTime/+'

# Example output

ucl/by-unid/<UNID>/ep0/Level/Attributes/OnTransitionTime/Desired { "value": <DESIRED_ON_TRANSITION_TIME>}
ucl/by-unid/<UNID>/ep0/Level/Attributes/OnTransitionTime/Reported { "value": <REPORTED_ON_TRANSITION_TIME>}

\subsection level_attr_off_transition_time Level/OffTransitionTime Attribute

MQTT Topic Pattern:

[PREFIX]/Level/Attributes/OffTransitionTime/Reported
[PREFIX]/Level/Attributes/OffTransitionTime/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Level Cluster OffTransitionTime Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for OffTransitionTime attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Level/Attributes/OffTransitionTime/+'

# Example output

ucl/by-unid/<UNID>/ep0/Level/Attributes/OffTransitionTime/Desired { "value": <DESIRED_OFF_TRANSITION_TIME>}
ucl/by-unid/<UNID>/ep0/Level/Attributes/OffTransitionTime/Reported { "value": <REPORTED_OFF_TRANSITION_TIME>}

\subsection level_attr_default_move_rate Level/DefaultMoveRate Attribute

MQTT Topic Pattern:

[PREFIX]/Level/Attributes/DefaultMoveRate/Reported
[PREFIX]/Level/Attributes/DefaultMoveRate/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Level Cluster DefaultMoveRate Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DefaultMoveRate attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Level/Attributes/DefaultMoveRate/+'

# Example output

ucl/by-unid/<UNID>/ep0/Level/Attributes/DefaultMoveRate/Desired { "value": <DESIRED_DEFAULT_MOVE_RATE>}
ucl/by-unid/<UNID>/ep0/Level/Attributes/DefaultMoveRate/Reported { "value": <REPORTED_DEFAULT_MOVE_RATE>}

\subsection level_attr_start_up_current_level Level/StartUpCurrentLevel Attribute

MQTT Topic Pattern:

[PREFIX]/Level/Attributes/StartUpCurrentLevel/Reported
[PREFIX]/Level/Attributes/StartUpCurrentLevel/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Level Cluster StartUpCurrentLevel Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for StartUpCurrentLevel attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Level/Attributes/StartUpCurrentLevel/+'

# Example output

ucl/by-unid/<UNID>/ep0/Level/Attributes/StartUpCurrentLevel/Desired { "value": <DESIRED_START_UP_CURRENT_LEVEL>}
ucl/by-unid/<UNID>/ep0/Level/Attributes/StartUpCurrentLevel/Reported { "value": <REPORTED_START_UP_CURRENT_LEVEL>}

\subsection level_attr_cluster_revision Level/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/Level/Attributes/ClusterRevision/Reported
[PREFIX]/Level/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Level Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Level/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/Level/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/Level/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section level_recv_cmd_support Level Command Support

MQTT Topic Pattern:

[PREFIX]/Level/SupportedCommands
[PREFIX]/Level/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Level Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
              "MoveToLevel",
              "Move",
              "Step",
              "Stop",
              "MoveToLevelWithOnOff",
              "MoveWithOnOff",
              "StepWithOnOff",
              "StopWithOnOff",
              "MoveToClosestFrequency",
              "WriteAttributes",
              "ForceReadAttributes"
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for Level cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Level/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/Level/SupportedCommands { "value": ["MoveToLevel","Move","Step","Stop","MoveToLevelWithOnOff","MoveWithOnOff","StepWithOnOff","StopWithOnOff","MoveToClosestFrequency","WriteAttributes", "ForceReadAttributes"] }

To see supported generated commands for Level cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Level/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/Level/SupportedGeneratedCommands { "value": [] }

\section level_cmds Level Commands

\subsection level_move_to_level_cmd Level/MoveToLevel Command

MQTT Topic Pattern:

[PREFIX]/Level/Commands/MoveToLevel
[PREFIX]/Level/GeneratedCommands/MoveToLevel

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Level Cluster MoveToLevel Command Properties",
  "type": "object",
  "properties": {
    "Level": {
      "type": "integer"
    },
    "TransitionTime": {
      "type": "integer"
    },
    "OptionsMask": {
      "type": "LevelOptions"
    },
    "OptionsOverride": {
      "type": "LevelOptions"
    }
  },
  "required": [
    "Level",
    "TransitionTime",
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Level/MoveToLevel command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Level/Commands/MoveToLevel' -m  '{ "Level": <LEVEL_VALUE>,"TransitionTime": <TRANSITION_TIME_VALUE>,"OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a Level/MoveToLevel generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Level/GeneratedCommands/MoveToLevel'

\subsection level_move_cmd Level/Move Command

MQTT Topic Pattern:

[PREFIX]/Level/Commands/Move
[PREFIX]/Level/GeneratedCommands/Move

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Level Cluster Move Command Properties",
  "type": "object",
  "properties": {
    "MoveMode": {
      "type": "MoveStepMode"
    },
    "Rate": {
      "type": "integer"
    },
    "OptionsMask": {
      "type": "LevelOptions"
    },
    "OptionsOverride": {
      "type": "LevelOptions"
    }
  },
  "required": [
    "MoveMode",
    "Rate",
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Level/Move command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Level/Commands/Move' -m  '{ "MoveMode": <MOVE_MODE_VALUE>,"Rate": <RATE_VALUE>,"OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a Level/Move generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Level/GeneratedCommands/Move'

\subsection level_step_cmd Level/Step Command

MQTT Topic Pattern:

[PREFIX]/Level/Commands/Step
[PREFIX]/Level/GeneratedCommands/Step

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Level Cluster Step Command Properties",
  "type": "object",
  "properties": {
    "StepMode": {
      "type": "MoveStepMode"
    },
    "StepSize": {
      "type": "integer"
    },
    "TransitionTime": {
      "type": "integer"
    },
    "OptionsMask": {
      "type": "LevelOptions"
    },
    "OptionsOverride": {
      "type": "LevelOptions"
    }
  },
  "required": [
    "StepMode",
    "StepSize",
    "TransitionTime",
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Level/Step command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Level/Commands/Step' -m  '{ "StepMode": <STEP_MODE_VALUE>,"StepSize": <STEP_SIZE_VALUE>,"TransitionTime": <TRANSITION_TIME_VALUE>,"OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a Level/Step generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Level/GeneratedCommands/Step'

\subsection level_stop_cmd Level/Stop Command

MQTT Topic Pattern:

[PREFIX]/Level/Commands/Stop
[PREFIX]/Level/GeneratedCommands/Stop

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Level Cluster Stop Command Properties",
  "type": "object",
  "properties": {
    "OptionsMask": {
      "type": "LevelOptions"
    },
    "OptionsOverride": {
      "type": "LevelOptions"
    }
  },
  "required": [
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Level/Stop command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Level/Commands/Stop' -m  '{ "OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a Level/Stop generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Level/GeneratedCommands/Stop'

\subsection level_move_to_level_with_on_off_cmd Level/MoveToLevelWithOnOff Command

MQTT Topic Pattern:

[PREFIX]/Level/Commands/MoveToLevelWithOnOff
[PREFIX]/Level/GeneratedCommands/MoveToLevelWithOnOff

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Level Cluster MoveToLevelWithOnOff Command Properties",
  "type": "object",
  "properties": {
    "Level": {
      "type": "integer"
    },
    "TransitionTime": {
      "type": "integer"
    },
    "OptionsMask": {
      "type": "LevelOptions"
    },
    "OptionsOverride": {
      "type": "LevelOptions"
    }
  },
  "required": [
    "Level",
    "TransitionTime",
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Level/MoveToLevelWithOnOff command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Level/Commands/MoveToLevelWithOnOff' -m  '{ "Level": <LEVEL_VALUE>,"TransitionTime": <TRANSITION_TIME_VALUE>,"OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a Level/MoveToLevelWithOnOff generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Level/GeneratedCommands/MoveToLevelWithOnOff'

\subsection level_move_with_on_off_cmd Level/MoveWithOnOff Command

MQTT Topic Pattern:

[PREFIX]/Level/Commands/MoveWithOnOff
[PREFIX]/Level/GeneratedCommands/MoveWithOnOff

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Level Cluster MoveWithOnOff Command Properties",
  "type": "object",
  "properties": {
    "MoveMode": {
      "type": "MoveStepMode"
    },
    "Rate": {
      "type": "integer"
    },
    "OptionsMask": {
      "type": "LevelOptions"
    },
    "OptionsOverride": {
      "type": "LevelOptions"
    }
  },
  "required": [
    "MoveMode",
    "Rate",
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Level/MoveWithOnOff command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Level/Commands/MoveWithOnOff' -m  '{ "MoveMode": <MOVE_MODE_VALUE>,"Rate": <RATE_VALUE>,"OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a Level/MoveWithOnOff generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Level/GeneratedCommands/MoveWithOnOff'

\subsection level_step_with_on_off_cmd Level/StepWithOnOff Command

MQTT Topic Pattern:

[PREFIX]/Level/Commands/StepWithOnOff
[PREFIX]/Level/GeneratedCommands/StepWithOnOff

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Level Cluster StepWithOnOff Command Properties",
  "type": "object",
  "properties": {
    "StepMode": {
      "type": "MoveStepMode"
    },
    "StepSize": {
      "type": "integer"
    },
    "TransitionTime": {
      "type": "integer"
    },
    "OptionsMask": {
      "type": "LevelOptions"
    },
    "OptionsOverride": {
      "type": "LevelOptions"
    }
  },
  "required": [
    "StepMode",
    "StepSize",
    "TransitionTime",
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Level/StepWithOnOff command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Level/Commands/StepWithOnOff' -m  '{ "StepMode": <STEP_MODE_VALUE>,"StepSize": <STEP_SIZE_VALUE>,"TransitionTime": <TRANSITION_TIME_VALUE>,"OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a Level/StepWithOnOff generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Level/GeneratedCommands/StepWithOnOff'

\subsection level_stop_with_on_off_cmd Level/StopWithOnOff Command

MQTT Topic Pattern:

[PREFIX]/Level/Commands/StopWithOnOff
[PREFIX]/Level/GeneratedCommands/StopWithOnOff

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Level Cluster StopWithOnOff Command Properties",
  "type": "object",
  "properties": {
    "OptionsMask": {
      "type": "LevelOptions"
    },
    "OptionsOverride": {
      "type": "LevelOptions"
    }
  },
  "required": [
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Level/StopWithOnOff command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Level/Commands/StopWithOnOff' -m  '{ "OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a Level/StopWithOnOff generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Level/GeneratedCommands/StopWithOnOff'

\subsection level_move_to_closest_frequency_cmd Level/MoveToClosestFrequency Command

MQTT Topic Pattern:

[PREFIX]/Level/Commands/MoveToClosestFrequency
[PREFIX]/Level/GeneratedCommands/MoveToClosestFrequency

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Level Cluster MoveToClosestFrequency Command Properties",
  "type": "object",
  "properties": {
    "Frequency": {
      "type": "integer"
    }
  },
  "required": [
    "Frequency"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Level/MoveToClosestFrequency command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Level/Commands/MoveToClosestFrequency' -m  '{ "Frequency": <FREQUENCY_VALUE> }'

To receive a Level/MoveToClosestFrequency generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Level/GeneratedCommands/MoveToClosestFrequency'

\subsection level_write_attr_cmd Level/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/Level/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Level Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
    "Options": {
      "type": "LevelOptions"
    },
    "OnOffTransitionTime": {
      "type": "integer"
    },
    "OnLevel": {
      "type": "integer"
    },
    "OnTransitionTime": {
      "type": "integer"
    },
    "OffTransitionTime": {
      "type": "integer"
    },
    "DefaultMoveRate": {
      "type": "integer"
    },
    "StartUpCurrentLevel": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all Level attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Level/Commands/WriteAttributes' -m  '{ "Options": <OPTIONS_VALUE> ,"OnOffTransitionTime": <ON_OFF_TRANSITION_TIME_VALUE> ,"OnLevel": <ON_LEVEL_VALUE> ,"OnTransitionTime": <ON_TRANSITION_TIME_VALUE> ,"OffTransitionTime": <OFF_TRANSITION_TIME_VALUE> ,"DefaultMoveRate": <DEFAULT_MOVE_RATE_VALUE> ,"StartUpCurrentLevel": <START_UP_CURRENT_LEVEL_VALUE>  }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection level_force_read_attr_cmd Level/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/Level/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Level Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "CurrentLevel",
          "RemainingTime",
          "MinLevel",
          "MaxLevel",
          "CurrentFrequency",
          "MinFrequency",
          "MaxFrequency",
          "Options",
          "OnOffTransitionTime",
          "OnLevel",
          "OnTransitionTime",
          "OffTransitionTime",
          "DefaultMoveRate",
          "StartUpCurrentLevel"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all Level attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Level/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the Level attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Level/Commands/ForceReadAttributes' -m  '{ "value": ["CurrentLevel"] }'

\page alarms Alarms Cluster The following commands and attributes are accepted as JSON payloads for the Alarms cluster.

\section alarms_attrs Alarms Attributes The following attribute topics are used to retrieve the Alarms cluster state.

\subsection alarms_attr_alarm_count Alarms/AlarmCount Attribute

MQTT Topic Pattern:

[PREFIX]/Alarms/Attributes/AlarmCount/Reported
[PREFIX]/Alarms/Attributes/AlarmCount/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Alarms Cluster AlarmCount Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for AlarmCount attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Alarms/Attributes/AlarmCount/+'

# Example output

ucl/by-unid/<UNID>/ep0/Alarms/Attributes/AlarmCount/Desired { "value": <DESIRED_ALARM_COUNT>}
ucl/by-unid/<UNID>/ep0/Alarms/Attributes/AlarmCount/Reported { "value": <REPORTED_ALARM_COUNT>}

\subsection alarms_attr_cluster_revision Alarms/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/Alarms/Attributes/ClusterRevision/Reported
[PREFIX]/Alarms/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Alarms Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Alarms/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/Alarms/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/Alarms/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section alarms_recv_cmd_support Alarms Command Support

MQTT Topic Pattern:

[PREFIX]/Alarms/SupportedCommands
[PREFIX]/Alarms/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Alarms Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
              "ResetAlarm",
              "Alarm",
              "ResetAllAlarms",
              "GetAlarmResponse",
              "GetAlarm",
              "ResetAlarmLog",
              "WriteAttributes",
              "ForceReadAttributes"
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for Alarms cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Alarms/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/Alarms/SupportedCommands { "value": ["ResetAlarm","ResetAllAlarms","GetAlarm","ResetAlarmLog","WriteAttributes", "ForceReadAttributes"] }

To see supported generated commands for Alarms cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Alarms/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/Alarms/SupportedGeneratedCommands { "value": ["Alarm","GetAlarmResponse",] }

\section alarms_cmds Alarms Commands

\subsection alarms_reset_alarm_cmd Alarms/ResetAlarm Command

MQTT Topic Pattern:

[PREFIX]/Alarms/Commands/ResetAlarm
[PREFIX]/Alarms/GeneratedCommands/ResetAlarm

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Alarms Cluster ResetAlarm Command Properties",
  "type": "object",
  "properties": {
    "AlarmCode": {
      "type": "ResetAlarmAlarmCode"
    },
    "ClusterIdentifier": {
      "type": "clusterId"
    }
  },
  "required": [
    "AlarmCode",
    "ClusterIdentifier"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Alarms/ResetAlarm command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Alarms/Commands/ResetAlarm' -m  '{ "AlarmCode": <ALARM_CODE_VALUE>,"ClusterIdentifier": <CLUSTER_IDENTIFIER_VALUE> }'

To receive a Alarms/ResetAlarm generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Alarms/GeneratedCommands/ResetAlarm'

\subsection alarms_alarm_cmd Alarms/Alarm Command

MQTT Topic Pattern:

[PREFIX]/Alarms/Commands/Alarm
[PREFIX]/Alarms/GeneratedCommands/Alarm

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Alarms Cluster Alarm Command Properties",
  "type": "object",
  "properties": {
    "AlarmCode": {
      "type": "AlarmAlarmCode"
    },
    "ClusterIdentifier": {
      "type": "clusterId"
    }
  },
  "required": [
    "AlarmCode",
    "ClusterIdentifier"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Alarms/Alarm command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Alarms/Commands/Alarm' -m  '{ "AlarmCode": <ALARM_CODE_VALUE>,"ClusterIdentifier": <CLUSTER_IDENTIFIER_VALUE> }'

To receive a Alarms/Alarm generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Alarms/GeneratedCommands/Alarm'

\subsection alarms_reset_all_alarms_cmd Alarms/ResetAllAlarms Command

MQTT Topic Pattern:

[PREFIX]/Alarms/Commands/ResetAllAlarms
[PREFIX]/Alarms/GeneratedCommands/ResetAllAlarms

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Alarms Cluster ResetAllAlarms Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
  ]
}

Example Mosquitto CLI Tool Usage

To send a Alarms/ResetAllAlarms command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Alarms/Commands/ResetAllAlarms' -m  '{  }'

To receive a Alarms/ResetAllAlarms generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Alarms/GeneratedCommands/ResetAllAlarms'

\subsection alarms_get_alarm_response_cmd Alarms/GetAlarmResponse Command

MQTT Topic Pattern:

[PREFIX]/Alarms/Commands/GetAlarmResponse
[PREFIX]/Alarms/GeneratedCommands/GetAlarmResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Alarms Cluster GetAlarmResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "zclStatus"
    },
    "AlarmCode": {
      "type": "GetAlarmResponseAlarmCode"
    },
    "ClusterIdentifier": {
      "type": "clusterId"
    },
    "TimeStamp": {
      "type": "integer"
    }
  },
  "required": [
    "Status",
    "AlarmCode",
    "ClusterIdentifier",
    "TimeStamp"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Alarms/GetAlarmResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Alarms/Commands/GetAlarmResponse' -m  '{ "Status": <STATUS_VALUE>,"AlarmCode": <ALARM_CODE_VALUE>,"ClusterIdentifier": <CLUSTER_IDENTIFIER_VALUE>,"TimeStamp": <TIME_STAMP_VALUE> }'

To receive a Alarms/GetAlarmResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Alarms/GeneratedCommands/GetAlarmResponse'

\subsection alarms_get_alarm_cmd Alarms/GetAlarm Command

MQTT Topic Pattern:

[PREFIX]/Alarms/Commands/GetAlarm
[PREFIX]/Alarms/GeneratedCommands/GetAlarm

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Alarms Cluster GetAlarm Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
  ]
}

Example Mosquitto CLI Tool Usage

To send a Alarms/GetAlarm command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Alarms/Commands/GetAlarm' -m  '{  }'

To receive a Alarms/GetAlarm generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Alarms/GeneratedCommands/GetAlarm'

\subsection alarms_reset_alarm_log_cmd Alarms/ResetAlarmLog Command

MQTT Topic Pattern:

[PREFIX]/Alarms/Commands/ResetAlarmLog
[PREFIX]/Alarms/GeneratedCommands/ResetAlarmLog

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Alarms Cluster ResetAlarmLog Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
  ]
}

Example Mosquitto CLI Tool Usage

To send a Alarms/ResetAlarmLog command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Alarms/Commands/ResetAlarmLog' -m  '{  }'

To receive a Alarms/ResetAlarmLog generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Alarms/GeneratedCommands/ResetAlarmLog'

\subsection alarms_write_attr_cmd Alarms/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/Alarms/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Alarms Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all Alarms attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Alarms/Commands/WriteAttributes' -m  '{  }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection alarms_force_read_attr_cmd Alarms/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/Alarms/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Alarms Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "AlarmCount"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all Alarms attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Alarms/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the Alarms attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Alarms/Commands/ForceReadAttributes' -m  '{ "value": ["AlarmCount"] }'

\page time Time Cluster The following commands and attributes are accepted as JSON payloads for the Time cluster.

\section time_attrs Time Attributes The following attribute topics are used to retrieve the Time cluster state.

\subsection time_attr_time Time/Time Attribute

MQTT Topic Pattern:

[PREFIX]/Time/Attributes/Time/Reported
[PREFIX]/Time/Attributes/Time/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Time Cluster Time Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "UTC"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Time attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Time/Attributes/Time/+'

# Example output

ucl/by-unid/<UNID>/ep0/Time/Attributes/Time/Desired { "value": <DESIRED_TIME>}
ucl/by-unid/<UNID>/ep0/Time/Attributes/Time/Reported { "value": <REPORTED_TIME>}

\subsection time_attr_time_status Time/TimeStatus Attribute

MQTT Topic Pattern:

[PREFIX]/Time/Attributes/TimeStatus/Reported
[PREFIX]/Time/Attributes/TimeStatus/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Time Cluster TimeStatus Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "TimeTimeStatus"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for TimeStatus attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Time/Attributes/TimeStatus/+'

# Example output

ucl/by-unid/<UNID>/ep0/Time/Attributes/TimeStatus/Desired { "value": <DESIRED_TIME_STATUS>}
ucl/by-unid/<UNID>/ep0/Time/Attributes/TimeStatus/Reported { "value": <REPORTED_TIME_STATUS>}

\subsection time_attr_time_zone Time/TimeZone Attribute

MQTT Topic Pattern:

[PREFIX]/Time/Attributes/TimeZone/Reported
[PREFIX]/Time/Attributes/TimeZone/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Time Cluster TimeZone Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for TimeZone attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Time/Attributes/TimeZone/+'

# Example output

ucl/by-unid/<UNID>/ep0/Time/Attributes/TimeZone/Desired { "value": <DESIRED_TIME_ZONE>}
ucl/by-unid/<UNID>/ep0/Time/Attributes/TimeZone/Reported { "value": <REPORTED_TIME_ZONE>}

\subsection time_attr_dst_start Time/DstStart Attribute

MQTT Topic Pattern:

[PREFIX]/Time/Attributes/DstStart/Reported
[PREFIX]/Time/Attributes/DstStart/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Time Cluster DstStart Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DstStart attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Time/Attributes/DstStart/+'

# Example output

ucl/by-unid/<UNID>/ep0/Time/Attributes/DstStart/Desired { "value": <DESIRED_DST_START>}
ucl/by-unid/<UNID>/ep0/Time/Attributes/DstStart/Reported { "value": <REPORTED_DST_START>}

\subsection time_attr_dst_end Time/DstEnd Attribute

MQTT Topic Pattern:

[PREFIX]/Time/Attributes/DstEnd/Reported
[PREFIX]/Time/Attributes/DstEnd/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Time Cluster DstEnd Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DstEnd attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Time/Attributes/DstEnd/+'

# Example output

ucl/by-unid/<UNID>/ep0/Time/Attributes/DstEnd/Desired { "value": <DESIRED_DST_END>}
ucl/by-unid/<UNID>/ep0/Time/Attributes/DstEnd/Reported { "value": <REPORTED_DST_END>}

\subsection time_attr_dst_shift Time/DstShift Attribute

MQTT Topic Pattern:

[PREFIX]/Time/Attributes/DstShift/Reported
[PREFIX]/Time/Attributes/DstShift/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Time Cluster DstShift Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DstShift attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Time/Attributes/DstShift/+'

# Example output

ucl/by-unid/<UNID>/ep0/Time/Attributes/DstShift/Desired { "value": <DESIRED_DST_SHIFT>}
ucl/by-unid/<UNID>/ep0/Time/Attributes/DstShift/Reported { "value": <REPORTED_DST_SHIFT>}

\subsection time_attr_standard_time Time/StandardTime Attribute

MQTT Topic Pattern:

[PREFIX]/Time/Attributes/StandardTime/Reported
[PREFIX]/Time/Attributes/StandardTime/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Time Cluster StandardTime Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for StandardTime attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Time/Attributes/StandardTime/+'

# Example output

ucl/by-unid/<UNID>/ep0/Time/Attributes/StandardTime/Desired { "value": <DESIRED_STANDARD_TIME>}
ucl/by-unid/<UNID>/ep0/Time/Attributes/StandardTime/Reported { "value": <REPORTED_STANDARD_TIME>}

\subsection time_attr_local_time Time/LocalTime Attribute

MQTT Topic Pattern:

[PREFIX]/Time/Attributes/LocalTime/Reported
[PREFIX]/Time/Attributes/LocalTime/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Time Cluster LocalTime Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for LocalTime attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Time/Attributes/LocalTime/+'

# Example output

ucl/by-unid/<UNID>/ep0/Time/Attributes/LocalTime/Desired { "value": <DESIRED_LOCAL_TIME>}
ucl/by-unid/<UNID>/ep0/Time/Attributes/LocalTime/Reported { "value": <REPORTED_LOCAL_TIME>}

\subsection time_attr_last_set_time Time/LastSetTime Attribute

MQTT Topic Pattern:

[PREFIX]/Time/Attributes/LastSetTime/Reported
[PREFIX]/Time/Attributes/LastSetTime/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Time Cluster LastSetTime Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "UTC"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for LastSetTime attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Time/Attributes/LastSetTime/+'

# Example output

ucl/by-unid/<UNID>/ep0/Time/Attributes/LastSetTime/Desired { "value": <DESIRED_LAST_SET_TIME>}
ucl/by-unid/<UNID>/ep0/Time/Attributes/LastSetTime/Reported { "value": <REPORTED_LAST_SET_TIME>}

\subsection time_attr_valid_until_time Time/ValidUntilTime Attribute

MQTT Topic Pattern:

[PREFIX]/Time/Attributes/ValidUntilTime/Reported
[PREFIX]/Time/Attributes/ValidUntilTime/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Time Cluster ValidUntilTime Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "UTC"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ValidUntilTime attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Time/Attributes/ValidUntilTime/+'

# Example output

ucl/by-unid/<UNID>/ep0/Time/Attributes/ValidUntilTime/Desired { "value": <DESIRED_VALID_UNTIL_TIME>}
ucl/by-unid/<UNID>/ep0/Time/Attributes/ValidUntilTime/Reported { "value": <REPORTED_VALID_UNTIL_TIME>}

\subsection time_attr_cluster_revision Time/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/Time/Attributes/ClusterRevision/Reported
[PREFIX]/Time/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Time Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Time/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/Time/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/Time/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section time_recv_cmd_support Time Command Support

MQTT Topic Pattern:

[PREFIX]/Time/SupportedCommands
[PREFIX]/Time/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Time Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for Time cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Time/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/Time/SupportedCommands { "value": [] }

To see supported generated commands for Time cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Time/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/Time/SupportedGeneratedCommands { "value": [] }

\section time_cmds Time Commands

\subsection time_write_attr_cmd Time/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/Time/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Time Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
    "Time": {
      "type": "UTC"
    },
    "TimeStatus": {
      "type": "TimeTimeStatus"
    },
    "TimeZone": {
      "type": "integer"
    },
    "DstStart": {
      "type": "integer"
    },
    "DstEnd": {
      "type": "integer"
    },
    "DstShift": {
      "type": "integer"
    },
    "ValidUntilTime": {
      "type": "UTC"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all Time attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Time/Commands/WriteAttributes' -m  '{ "Time": <TIME_VALUE> ,"TimeStatus": <TIME_STATUS_VALUE> ,"TimeZone": <TIME_ZONE_VALUE> ,"DstStart": <DST_START_VALUE> ,"DstEnd": <DST_END_VALUE> ,"DstShift": <DST_SHIFT_VALUE> ,"ValidUntilTime": <VALID_UNTIL_TIME_VALUE>  }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection time_force_read_attr_cmd Time/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/Time/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Time Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "Time",
          "TimeStatus",
          "TimeZone",
          "DstStart",
          "DstEnd",
          "DstShift",
          "StandardTime",
          "LocalTime",
          "LastSetTime",
          "ValidUntilTime"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all Time attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Time/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the Time attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Time/Commands/ForceReadAttributes' -m  '{ "value": ["Time"] }'

\page poll_control PollControl Cluster The following commands and attributes are accepted as JSON payloads for the PollControl cluster.

\section poll_control_attrs PollControl Attributes The following attribute topics are used to retrieve the PollControl cluster state.

\subsection poll_control_attr_check_in_interval PollControl/CheckInInterval Attribute

MQTT Topic Pattern:

[PREFIX]/PollControl/Attributes/CheckInInterval/Reported
[PREFIX]/PollControl/Attributes/CheckInInterval/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PollControl Cluster CheckInInterval Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CheckInInterval attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PollControl/Attributes/CheckInInterval/+'

# Example output

ucl/by-unid/<UNID>/ep0/PollControl/Attributes/CheckInInterval/Desired { "value": <DESIRED_CHECK_IN_INTERVAL>}
ucl/by-unid/<UNID>/ep0/PollControl/Attributes/CheckInInterval/Reported { "value": <REPORTED_CHECK_IN_INTERVAL>}

\subsection poll_control_attr_long_poll_interval PollControl/LongPollInterval Attribute

MQTT Topic Pattern:

[PREFIX]/PollControl/Attributes/LongPollInterval/Reported
[PREFIX]/PollControl/Attributes/LongPollInterval/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PollControl Cluster LongPollInterval Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for LongPollInterval attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PollControl/Attributes/LongPollInterval/+'

# Example output

ucl/by-unid/<UNID>/ep0/PollControl/Attributes/LongPollInterval/Desired { "value": <DESIRED_LONG_POLL_INTERVAL>}
ucl/by-unid/<UNID>/ep0/PollControl/Attributes/LongPollInterval/Reported { "value": <REPORTED_LONG_POLL_INTERVAL>}

\subsection poll_control_attr_short_poll_interval PollControl/ShortPollInterval Attribute

MQTT Topic Pattern:

[PREFIX]/PollControl/Attributes/ShortPollInterval/Reported
[PREFIX]/PollControl/Attributes/ShortPollInterval/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PollControl Cluster ShortPollInterval Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ShortPollInterval attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PollControl/Attributes/ShortPollInterval/+'

# Example output

ucl/by-unid/<UNID>/ep0/PollControl/Attributes/ShortPollInterval/Desired { "value": <DESIRED_SHORT_POLL_INTERVAL>}
ucl/by-unid/<UNID>/ep0/PollControl/Attributes/ShortPollInterval/Reported { "value": <REPORTED_SHORT_POLL_INTERVAL>}

\subsection poll_control_attr_fast_poll_timeout PollControl/FastPollTimeout Attribute

MQTT Topic Pattern:

[PREFIX]/PollControl/Attributes/FastPollTimeout/Reported
[PREFIX]/PollControl/Attributes/FastPollTimeout/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PollControl Cluster FastPollTimeout Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for FastPollTimeout attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PollControl/Attributes/FastPollTimeout/+'

# Example output

ucl/by-unid/<UNID>/ep0/PollControl/Attributes/FastPollTimeout/Desired { "value": <DESIRED_FAST_POLL_TIMEOUT>}
ucl/by-unid/<UNID>/ep0/PollControl/Attributes/FastPollTimeout/Reported { "value": <REPORTED_FAST_POLL_TIMEOUT>}

\subsection poll_control_attr_check_in_interval_min PollControl/CheckInIntervalMin Attribute

MQTT Topic Pattern:

[PREFIX]/PollControl/Attributes/CheckInIntervalMin/Reported
[PREFIX]/PollControl/Attributes/CheckInIntervalMin/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PollControl Cluster CheckInIntervalMin Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CheckInIntervalMin attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PollControl/Attributes/CheckInIntervalMin/+'

# Example output

ucl/by-unid/<UNID>/ep0/PollControl/Attributes/CheckInIntervalMin/Desired { "value": <DESIRED_CHECK_IN_INTERVAL_MIN>}
ucl/by-unid/<UNID>/ep0/PollControl/Attributes/CheckInIntervalMin/Reported { "value": <REPORTED_CHECK_IN_INTERVAL_MIN>}

\subsection poll_control_attr_long_poll_interval_min PollControl/LongPollIntervalMin Attribute

MQTT Topic Pattern:

[PREFIX]/PollControl/Attributes/LongPollIntervalMin/Reported
[PREFIX]/PollControl/Attributes/LongPollIntervalMin/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PollControl Cluster LongPollIntervalMin Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for LongPollIntervalMin attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PollControl/Attributes/LongPollIntervalMin/+'

# Example output

ucl/by-unid/<UNID>/ep0/PollControl/Attributes/LongPollIntervalMin/Desired { "value": <DESIRED_LONG_POLL_INTERVAL_MIN>}
ucl/by-unid/<UNID>/ep0/PollControl/Attributes/LongPollIntervalMin/Reported { "value": <REPORTED_LONG_POLL_INTERVAL_MIN>}

\subsection poll_control_attr_fast_poll_timeout_max PollControl/FastPollTimeoutMax Attribute

MQTT Topic Pattern:

[PREFIX]/PollControl/Attributes/FastPollTimeoutMax/Reported
[PREFIX]/PollControl/Attributes/FastPollTimeoutMax/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PollControl Cluster FastPollTimeoutMax Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for FastPollTimeoutMax attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PollControl/Attributes/FastPollTimeoutMax/+'

# Example output

ucl/by-unid/<UNID>/ep0/PollControl/Attributes/FastPollTimeoutMax/Desired { "value": <DESIRED_FAST_POLL_TIMEOUT_MAX>}
ucl/by-unid/<UNID>/ep0/PollControl/Attributes/FastPollTimeoutMax/Reported { "value": <REPORTED_FAST_POLL_TIMEOUT_MAX>}

\subsection poll_control_attr_cluster_revision PollControl/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/PollControl/Attributes/ClusterRevision/Reported
[PREFIX]/PollControl/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PollControl Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/PollControl/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/PollControl/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/PollControl/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section poll_control_recv_cmd_support PollControl Command Support

MQTT Topic Pattern:

[PREFIX]/PollControl/SupportedCommands
[PREFIX]/PollControl/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PollControl Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
              "CheckIn",
              "CheckInResponse",
              "FastPollStop",
              "SetLongPollInterval",
              "SetShortPollInterval",
              "WriteAttributes",
              "ForceReadAttributes"
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for PollControl cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/PollControl/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/PollControl/SupportedCommands { "value": ["CheckIn",] }

To see supported generated commands for PollControl cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/PollControl/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/PollControl/SupportedGeneratedCommands { "value": ["CheckInResponse","FastPollStop","SetLongPollInterval","SetShortPollInterval"] }

\section poll_control_cmds PollControl Commands

\subsection poll_control_check_in_cmd PollControl/CheckIn Command

MQTT Topic Pattern:

[PREFIX]/PollControl/Commands/CheckIn
[PREFIX]/PollControl/GeneratedCommands/CheckIn

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PollControl Cluster CheckIn Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
  ]
}

Example Mosquitto CLI Tool Usage

To send a PollControl/CheckIn command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/PollControl/Commands/CheckIn' -m  '{  }'

To receive a PollControl/CheckIn generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/PollControl/GeneratedCommands/CheckIn'

\subsection poll_control_check_in_response_cmd PollControl/CheckInResponse Command

MQTT Topic Pattern:

[PREFIX]/PollControl/Commands/CheckInResponse
[PREFIX]/PollControl/GeneratedCommands/CheckInResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PollControl Cluster CheckInResponse Command Properties",
  "type": "object",
  "properties": {
    "StartFastPolling": {
      "type": "boolean"
    },
    "FastPollTimeout": {
      "type": "integer"
    }
  },
  "required": [
    "StartFastPolling",
    "FastPollTimeout"
  ]
}

Example Mosquitto CLI Tool Usage

To send a PollControl/CheckInResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/PollControl/Commands/CheckInResponse' -m  '{ "StartFastPolling": <START_FAST_POLLING_VALUE>,"FastPollTimeout": <FAST_POLL_TIMEOUT_VALUE> }'

To receive a PollControl/CheckInResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/PollControl/GeneratedCommands/CheckInResponse'

\subsection poll_control_fast_poll_stop_cmd PollControl/FastPollStop Command

MQTT Topic Pattern:

[PREFIX]/PollControl/Commands/FastPollStop
[PREFIX]/PollControl/GeneratedCommands/FastPollStop

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PollControl Cluster FastPollStop Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
  ]
}

Example Mosquitto CLI Tool Usage

To send a PollControl/FastPollStop command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/PollControl/Commands/FastPollStop' -m  '{  }'

To receive a PollControl/FastPollStop generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/PollControl/GeneratedCommands/FastPollStop'

\subsection poll_control_set_long_poll_interval_cmd PollControl/SetLongPollInterval Command

MQTT Topic Pattern:

[PREFIX]/PollControl/Commands/SetLongPollInterval
[PREFIX]/PollControl/GeneratedCommands/SetLongPollInterval

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PollControl Cluster SetLongPollInterval Command Properties",
  "type": "object",
  "properties": {
    "NewLongPollInterval": {
      "type": "integer"
    }
  },
  "required": [
    "NewLongPollInterval"
  ]
}

Example Mosquitto CLI Tool Usage

To send a PollControl/SetLongPollInterval command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/PollControl/Commands/SetLongPollInterval' -m  '{ "NewLongPollInterval": <NEW_LONG_POLL_INTERVAL_VALUE> }'

To receive a PollControl/SetLongPollInterval generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/PollControl/GeneratedCommands/SetLongPollInterval'

\subsection poll_control_set_short_poll_interval_cmd PollControl/SetShortPollInterval Command

MQTT Topic Pattern:

[PREFIX]/PollControl/Commands/SetShortPollInterval
[PREFIX]/PollControl/GeneratedCommands/SetShortPollInterval

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PollControl Cluster SetShortPollInterval Command Properties",
  "type": "object",
  "properties": {
    "NewShortPollInterval": {
      "type": "integer"
    }
  },
  "required": [
    "NewShortPollInterval"
  ]
}

Example Mosquitto CLI Tool Usage

To send a PollControl/SetShortPollInterval command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/PollControl/Commands/SetShortPollInterval' -m  '{ "NewShortPollInterval": <NEW_SHORT_POLL_INTERVAL_VALUE> }'

To receive a PollControl/SetShortPollInterval generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/PollControl/GeneratedCommands/SetShortPollInterval'

\subsection poll_control_write_attr_cmd PollControl/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/PollControl/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PollControl Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
    "CheckInInterval": {
      "type": "integer"
    },
    "FastPollTimeout": {
      "type": "integer"
    },
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all PollControl attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/PollControl/Commands/WriteAttributes' -m  '{ "CheckInInterval": <CHECK_IN_INTERVAL_VALUE> ,"FastPollTimeout": <FAST_POLL_TIMEOUT_VALUE> , }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection poll_control_force_read_attr_cmd PollControl/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/PollControl/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PollControl Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "CheckInInterval",
          "LongPollInterval",
          "ShortPollInterval",
          "FastPollTimeout",
          "CheckInIntervalMin",
          "LongPollIntervalMin",
          "FastPollTimeoutMax"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all PollControl attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/PollControl/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the PollControl attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/PollControl/Commands/ForceReadAttributes' -m  '{ "value": ["CheckInInterval"] }'

\page shade_configuration ShadeConfiguration Cluster The following commands and attributes are accepted as JSON payloads for the ShadeConfiguration cluster.

\section shade_configuration_attrs ShadeConfiguration Attributes The following attribute topics are used to retrieve the ShadeConfiguration cluster state.

\subsection shade_configuration_attr_physical_closed_limit ShadeConfiguration/PhysicalClosedLimit Attribute

MQTT Topic Pattern:

[PREFIX]/ShadeConfiguration/Attributes/PhysicalClosedLimit/Reported
[PREFIX]/ShadeConfiguration/Attributes/PhysicalClosedLimit/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ShadeConfiguration Cluster PhysicalClosedLimit Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for PhysicalClosedLimit attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ShadeConfiguration/Attributes/PhysicalClosedLimit/+'

# Example output

ucl/by-unid/<UNID>/ep0/ShadeConfiguration/Attributes/PhysicalClosedLimit/Desired { "value": <DESIRED_PHYSICAL_CLOSED_LIMIT>}
ucl/by-unid/<UNID>/ep0/ShadeConfiguration/Attributes/PhysicalClosedLimit/Reported { "value": <REPORTED_PHYSICAL_CLOSED_LIMIT>}

\subsection shade_configuration_attr_motor_step_size ShadeConfiguration/MotorStepSize Attribute

MQTT Topic Pattern:

[PREFIX]/ShadeConfiguration/Attributes/MotorStepSize/Reported
[PREFIX]/ShadeConfiguration/Attributes/MotorStepSize/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ShadeConfiguration Cluster MotorStepSize Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MotorStepSize attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ShadeConfiguration/Attributes/MotorStepSize/+'

# Example output

ucl/by-unid/<UNID>/ep0/ShadeConfiguration/Attributes/MotorStepSize/Desired { "value": <DESIRED_MOTOR_STEP_SIZE>}
ucl/by-unid/<UNID>/ep0/ShadeConfiguration/Attributes/MotorStepSize/Reported { "value": <REPORTED_MOTOR_STEP_SIZE>}

\subsection shade_configuration_attr_status ShadeConfiguration/Status Attribute

MQTT Topic Pattern:

[PREFIX]/ShadeConfiguration/Attributes/Status/Reported
[PREFIX]/ShadeConfiguration/Attributes/Status/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ShadeConfiguration Cluster Status Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ShadeConfigurationStatus"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Status attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ShadeConfiguration/Attributes/Status/+'

# Example output

ucl/by-unid/<UNID>/ep0/ShadeConfiguration/Attributes/Status/Desired { "value": <DESIRED_STATUS>}
ucl/by-unid/<UNID>/ep0/ShadeConfiguration/Attributes/Status/Reported { "value": <REPORTED_STATUS>}

\subsection shade_configuration_attr_closed_limit ShadeConfiguration/ClosedLimit Attribute

MQTT Topic Pattern:

[PREFIX]/ShadeConfiguration/Attributes/ClosedLimit/Reported
[PREFIX]/ShadeConfiguration/Attributes/ClosedLimit/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ShadeConfiguration Cluster ClosedLimit Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClosedLimit attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ShadeConfiguration/Attributes/ClosedLimit/+'

# Example output

ucl/by-unid/<UNID>/ep0/ShadeConfiguration/Attributes/ClosedLimit/Desired { "value": <DESIRED_CLOSED_LIMIT>}
ucl/by-unid/<UNID>/ep0/ShadeConfiguration/Attributes/ClosedLimit/Reported { "value": <REPORTED_CLOSED_LIMIT>}

\subsection shade_configuration_attr_mode ShadeConfiguration/Mode Attribute

MQTT Topic Pattern:

[PREFIX]/ShadeConfiguration/Attributes/Mode/Reported
[PREFIX]/ShadeConfiguration/Attributes/Mode/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ShadeConfiguration Cluster Mode Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ShadeConfigurationMode"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Mode attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ShadeConfiguration/Attributes/Mode/+'

# Example output

ucl/by-unid/<UNID>/ep0/ShadeConfiguration/Attributes/Mode/Desired { "value": <DESIRED_MODE>}
ucl/by-unid/<UNID>/ep0/ShadeConfiguration/Attributes/Mode/Reported { "value": <REPORTED_MODE>}

\subsection shade_configuration_attr_cluster_revision ShadeConfiguration/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/ShadeConfiguration/Attributes/ClusterRevision/Reported
[PREFIX]/ShadeConfiguration/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ShadeConfiguration Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ShadeConfiguration/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/ShadeConfiguration/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/ShadeConfiguration/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section shade_configuration_recv_cmd_support ShadeConfiguration Command Support

MQTT Topic Pattern:

[PREFIX]/ShadeConfiguration/SupportedCommands
[PREFIX]/ShadeConfiguration/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ShadeConfiguration Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for ShadeConfiguration cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ShadeConfiguration/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/ShadeConfiguration/SupportedCommands { "value": [] }

To see supported generated commands for ShadeConfiguration cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ShadeConfiguration/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/ShadeConfiguration/SupportedGeneratedCommands { "value": [] }

\section shade_configuration_cmds ShadeConfiguration Commands

\subsection shade_configuration_write_attr_cmd ShadeConfiguration/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/ShadeConfiguration/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ShadeConfiguration Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "ShadeConfigurationStatus"
    },
    "ClosedLimit": {
      "type": "integer"
    },
    "Mode": {
      "type": "ShadeConfigurationMode"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all ShadeConfiguration attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ShadeConfiguration/Commands/WriteAttributes' -m  '{ "Status": <STATUS_VALUE> ,"ClosedLimit": <CLOSED_LIMIT_VALUE> ,"Mode": <MODE_VALUE>  }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection shade_configuration_force_read_attr_cmd ShadeConfiguration/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/ShadeConfiguration/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ShadeConfiguration Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "PhysicalClosedLimit",
          "MotorStepSize",
          "Status",
          "ClosedLimit",
          "Mode"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all ShadeConfiguration attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ShadeConfiguration/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the ShadeConfiguration attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ShadeConfiguration/Commands/ForceReadAttributes' -m  '{ "value": ["PhysicalClosedLimit"] }'

\page door_lock DoorLock Cluster The following commands and attributes are accepted as JSON payloads for the DoorLock cluster.

\section door_lock_attrs DoorLock Attributes The following attribute topics are used to retrieve the DoorLock cluster state.

\subsection door_lock_attr_lock_state DoorLock/LockState Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/LockState/Reported
[PREFIX]/DoorLock/Attributes/LockState/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster LockState Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "DoorLockLockState"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for LockState attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/LockState/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/LockState/Desired { "value": <DESIRED_LOCK_STATE>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/LockState/Reported { "value": <REPORTED_LOCK_STATE>}

\subsection door_lock_attr_lock_type DoorLock/LockType Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/LockType/Reported
[PREFIX]/DoorLock/Attributes/LockType/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster LockType Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "DoorLockLockType"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for LockType attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/LockType/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/LockType/Desired { "value": <DESIRED_LOCK_TYPE>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/LockType/Reported { "value": <REPORTED_LOCK_TYPE>}

\subsection door_lock_attr_actuator_enabled DoorLock/ActuatorEnabled Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/ActuatorEnabled/Reported
[PREFIX]/DoorLock/Attributes/ActuatorEnabled/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ActuatorEnabled Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "boolean"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ActuatorEnabled attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/ActuatorEnabled/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/ActuatorEnabled/Desired { "value": <DESIRED_ACTUATOR_ENABLED>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/ActuatorEnabled/Reported { "value": <REPORTED_ACTUATOR_ENABLED>}

\subsection door_lock_attr_door_state DoorLock/DoorState Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/DoorState/Reported
[PREFIX]/DoorLock/Attributes/DoorState/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster DoorState Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "DoorLockDoorState"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DoorState attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/DoorState/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/DoorState/Desired { "value": <DESIRED_DOOR_STATE>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/DoorState/Reported { "value": <REPORTED_DOOR_STATE>}

\subsection door_lock_attr_door_open_events DoorLock/DoorOpenEvents Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/DoorOpenEvents/Reported
[PREFIX]/DoorLock/Attributes/DoorOpenEvents/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster DoorOpenEvents Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DoorOpenEvents attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/DoorOpenEvents/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/DoorOpenEvents/Desired { "value": <DESIRED_DOOR_OPEN_EVENTS>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/DoorOpenEvents/Reported { "value": <REPORTED_DOOR_OPEN_EVENTS>}

\subsection door_lock_attr_door_closed_events DoorLock/DoorClosedEvents Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/DoorClosedEvents/Reported
[PREFIX]/DoorLock/Attributes/DoorClosedEvents/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster DoorClosedEvents Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DoorClosedEvents attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/DoorClosedEvents/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/DoorClosedEvents/Desired { "value": <DESIRED_DOOR_CLOSED_EVENTS>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/DoorClosedEvents/Reported { "value": <REPORTED_DOOR_CLOSED_EVENTS>}

\subsection door_lock_attr_open_period DoorLock/OpenPeriod Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/OpenPeriod/Reported
[PREFIX]/DoorLock/Attributes/OpenPeriod/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster OpenPeriod Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for OpenPeriod attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/OpenPeriod/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/OpenPeriod/Desired { "value": <DESIRED_OPEN_PERIOD>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/OpenPeriod/Reported { "value": <REPORTED_OPEN_PERIOD>}

\subsection door_lock_attr_number_of_log_records_supported DoorLock/NumberOfLogRecordsSupported Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/NumberOfLogRecordsSupported/Reported
[PREFIX]/DoorLock/Attributes/NumberOfLogRecordsSupported/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster NumberOfLogRecordsSupported Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for NumberOfLogRecordsSupported attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/NumberOfLogRecordsSupported/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/NumberOfLogRecordsSupported/Desired { "value": <DESIRED_NUMBER_OF_LOG_RECORDS_SUPPORTED>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/NumberOfLogRecordsSupported/Reported { "value": <REPORTED_NUMBER_OF_LOG_RECORDS_SUPPORTED>}

\subsection door_lock_attr_number_of_total_users_supported DoorLock/NumberOfTotalUsersSupported Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/NumberOfTotalUsersSupported/Reported
[PREFIX]/DoorLock/Attributes/NumberOfTotalUsersSupported/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster NumberOfTotalUsersSupported Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for NumberOfTotalUsersSupported attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/NumberOfTotalUsersSupported/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/NumberOfTotalUsersSupported/Desired { "value": <DESIRED_NUMBER_OF_TOTAL_USERS_SUPPORTED>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/NumberOfTotalUsersSupported/Reported { "value": <REPORTED_NUMBER_OF_TOTAL_USERS_SUPPORTED>}

\subsection door_lock_attr_number_of_pin_users_supported DoorLock/NumberOfPINUsersSupported Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/NumberOfPINUsersSupported/Reported
[PREFIX]/DoorLock/Attributes/NumberOfPINUsersSupported/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster NumberOfPINUsersSupported Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for NumberOfPINUsersSupported attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/NumberOfPINUsersSupported/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/NumberOfPINUsersSupported/Desired { "value": <DESIRED_NUMBER_OF_PIN_USERS_SUPPORTED>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/NumberOfPINUsersSupported/Reported { "value": <REPORTED_NUMBER_OF_PIN_USERS_SUPPORTED>}

\subsection door_lock_attr_number_of_rfid_users_supported DoorLock/NumberOfRFIDUsersSupported Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/NumberOfRFIDUsersSupported/Reported
[PREFIX]/DoorLock/Attributes/NumberOfRFIDUsersSupported/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster NumberOfRFIDUsersSupported Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for NumberOfRFIDUsersSupported attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/NumberOfRFIDUsersSupported/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/NumberOfRFIDUsersSupported/Desired { "value": <DESIRED_NUMBER_OF_RFID_USERS_SUPPORTED>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/NumberOfRFIDUsersSupported/Reported { "value": <REPORTED_NUMBER_OF_RFID_USERS_SUPPORTED>}

\subsection door_lock_attr_number_of_week_day_schedules_supported_per_user DoorLock/NumberOfWeekDaySchedulesSupportedPerUser Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/NumberOfWeekDaySchedulesSupportedPerUser/Reported
[PREFIX]/DoorLock/Attributes/NumberOfWeekDaySchedulesSupportedPerUser/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster NumberOfWeekDaySchedulesSupportedPerUser Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for NumberOfWeekDaySchedulesSupportedPerUser attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/NumberOfWeekDaySchedulesSupportedPerUser/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/NumberOfWeekDaySchedulesSupportedPerUser/Desired { "value": <DESIRED_NUMBER_OF_WEEK_DAY_SCHEDULES_SUPPORTED_PER_USER>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/NumberOfWeekDaySchedulesSupportedPerUser/Reported { "value": <REPORTED_NUMBER_OF_WEEK_DAY_SCHEDULES_SUPPORTED_PER_USER>}

\subsection door_lock_attr_number_of_year_day_schedules_supported_per_user DoorLock/NumberOfYearDaySchedulesSupportedPerUser Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/NumberOfYearDaySchedulesSupportedPerUser/Reported
[PREFIX]/DoorLock/Attributes/NumberOfYearDaySchedulesSupportedPerUser/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster NumberOfYearDaySchedulesSupportedPerUser Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for NumberOfYearDaySchedulesSupportedPerUser attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/NumberOfYearDaySchedulesSupportedPerUser/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/NumberOfYearDaySchedulesSupportedPerUser/Desired { "value": <DESIRED_NUMBER_OF_YEAR_DAY_SCHEDULES_SUPPORTED_PER_USER>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/NumberOfYearDaySchedulesSupportedPerUser/Reported { "value": <REPORTED_NUMBER_OF_YEAR_DAY_SCHEDULES_SUPPORTED_PER_USER>}

\subsection door_lock_attr_number_of_holiday_schedules_supported DoorLock/NumberOfHolidaySchedulesSupported Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/NumberOfHolidaySchedulesSupported/Reported
[PREFIX]/DoorLock/Attributes/NumberOfHolidaySchedulesSupported/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster NumberOfHolidaySchedulesSupported Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for NumberOfHolidaySchedulesSupported attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/NumberOfHolidaySchedulesSupported/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/NumberOfHolidaySchedulesSupported/Desired { "value": <DESIRED_NUMBER_OF_HOLIDAY_SCHEDULES_SUPPORTED>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/NumberOfHolidaySchedulesSupported/Reported { "value": <REPORTED_NUMBER_OF_HOLIDAY_SCHEDULES_SUPPORTED>}

\subsection door_lock_attr_max_pin_code_length DoorLock/MaxPINCodeLength Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/MaxPINCodeLength/Reported
[PREFIX]/DoorLock/Attributes/MaxPINCodeLength/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster MaxPINCodeLength Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MaxPINCodeLength attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/MaxPINCodeLength/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/MaxPINCodeLength/Desired { "value": <DESIRED_MAX_PIN_CODE_LENGTH>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/MaxPINCodeLength/Reported { "value": <REPORTED_MAX_PIN_CODE_LENGTH>}

\subsection door_lock_attr_min_pin_code_length DoorLock/MinPINCodeLength Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/MinPINCodeLength/Reported
[PREFIX]/DoorLock/Attributes/MinPINCodeLength/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster MinPINCodeLength Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MinPINCodeLength attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/MinPINCodeLength/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/MinPINCodeLength/Desired { "value": <DESIRED_MIN_PIN_CODE_LENGTH>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/MinPINCodeLength/Reported { "value": <REPORTED_MIN_PIN_CODE_LENGTH>}

\subsection door_lock_attr_max_rfid_code_length DoorLock/MaxRFIDCodeLength Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/MaxRFIDCodeLength/Reported
[PREFIX]/DoorLock/Attributes/MaxRFIDCodeLength/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster MaxRFIDCodeLength Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MaxRFIDCodeLength attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/MaxRFIDCodeLength/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/MaxRFIDCodeLength/Desired { "value": <DESIRED_MAX_RFID_CODE_LENGTH>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/MaxRFIDCodeLength/Reported { "value": <REPORTED_MAX_RFID_CODE_LENGTH>}

\subsection door_lock_attr_min_rfid_code_length DoorLock/MinRFIDCodeLength Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/MinRFIDCodeLength/Reported
[PREFIX]/DoorLock/Attributes/MinRFIDCodeLength/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster MinRFIDCodeLength Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MinRFIDCodeLength attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/MinRFIDCodeLength/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/MinRFIDCodeLength/Desired { "value": <DESIRED_MIN_RFID_CODE_LENGTH>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/MinRFIDCodeLength/Reported { "value": <REPORTED_MIN_RFID_CODE_LENGTH>}

\subsection door_lock_attr_credential_rules_support DoorLock/CredentialRulesSupport Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/CredentialRulesSupport/Reported
[PREFIX]/DoorLock/Attributes/CredentialRulesSupport/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster CredentialRulesSupport Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "DoorLockCredentialRulesSupport"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CredentialRulesSupport attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/CredentialRulesSupport/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/CredentialRulesSupport/Desired { "value": <DESIRED_CREDENTIAL_RULES_SUPPORT>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/CredentialRulesSupport/Reported { "value": <REPORTED_CREDENTIAL_RULES_SUPPORT>}

\subsection door_lock_attr_number_of_credentials_supported_per_user DoorLock/NumberOfCredentialsSupportedPerUser Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/NumberOfCredentialsSupportedPerUser/Reported
[PREFIX]/DoorLock/Attributes/NumberOfCredentialsSupportedPerUser/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster NumberOfCredentialsSupportedPerUser Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for NumberOfCredentialsSupportedPerUser attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/NumberOfCredentialsSupportedPerUser/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/NumberOfCredentialsSupportedPerUser/Desired { "value": <DESIRED_NUMBER_OF_CREDENTIALS_SUPPORTED_PER_USER>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/NumberOfCredentialsSupportedPerUser/Reported { "value": <REPORTED_NUMBER_OF_CREDENTIALS_SUPPORTED_PER_USER>}

\subsection door_lock_attr_enable_logging DoorLock/EnableLogging Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/EnableLogging/Reported
[PREFIX]/DoorLock/Attributes/EnableLogging/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster EnableLogging Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "boolean"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for EnableLogging attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/EnableLogging/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/EnableLogging/Desired { "value": <DESIRED_ENABLE_LOGGING>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/EnableLogging/Reported { "value": <REPORTED_ENABLE_LOGGING>}

\subsection door_lock_attr_language DoorLock/Language Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/Language/Reported
[PREFIX]/DoorLock/Attributes/Language/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster Language Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Language attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/Language/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/Language/Desired { "value": <DESIRED_LANGUAGE>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/Language/Reported { "value": <REPORTED_LANGUAGE>}

\subsection door_lock_attr_led_settings DoorLock/LEDSettings Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/LEDSettings/Reported
[PREFIX]/DoorLock/Attributes/LEDSettings/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster LEDSettings Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for LEDSettings attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/LEDSettings/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/LEDSettings/Desired { "value": <DESIRED_LED_SETTINGS>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/LEDSettings/Reported { "value": <REPORTED_LED_SETTINGS>}

\subsection door_lock_attr_auto_relock_time DoorLock/AutoRelockTime Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/AutoRelockTime/Reported
[PREFIX]/DoorLock/Attributes/AutoRelockTime/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster AutoRelockTime Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for AutoRelockTime attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/AutoRelockTime/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/AutoRelockTime/Desired { "value": <DESIRED_AUTO_RELOCK_TIME>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/AutoRelockTime/Reported { "value": <REPORTED_AUTO_RELOCK_TIME>}

\subsection door_lock_attr_sound_volume DoorLock/SoundVolume Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/SoundVolume/Reported
[PREFIX]/DoorLock/Attributes/SoundVolume/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster SoundVolume Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for SoundVolume attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/SoundVolume/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/SoundVolume/Desired { "value": <DESIRED_SOUND_VOLUME>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/SoundVolume/Reported { "value": <REPORTED_SOUND_VOLUME>}

\subsection door_lock_attr_operating_mode DoorLock/OperatingMode Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/OperatingMode/Reported
[PREFIX]/DoorLock/Attributes/OperatingMode/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster OperatingMode Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "DrlkOperMode"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for OperatingMode attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/OperatingMode/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/OperatingMode/Desired { "value": <DESIRED_OPERATING_MODE>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/OperatingMode/Reported { "value": <REPORTED_OPERATING_MODE>}

\subsection door_lock_attr_supported_operating_modes DoorLock/SupportedOperatingModes Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/SupportedOperatingModes/Reported
[PREFIX]/DoorLock/Attributes/SupportedOperatingModes/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster SupportedOperatingModes Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "DoorLockSupportedOperatingModes"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for SupportedOperatingModes attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/SupportedOperatingModes/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/SupportedOperatingModes/Desired { "value": <DESIRED_SUPPORTED_OPERATING_MODES>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/SupportedOperatingModes/Reported { "value": <REPORTED_SUPPORTED_OPERATING_MODES>}

\subsection door_lock_attr_default_configuration_register DoorLock/DefaultConfigurationRegister Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/DefaultConfigurationRegister/Reported
[PREFIX]/DoorLock/Attributes/DefaultConfigurationRegister/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster DefaultConfigurationRegister Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "DoorLockDefaultConfigurationRegister"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DefaultConfigurationRegister attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/DefaultConfigurationRegister/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/DefaultConfigurationRegister/Desired { "value": <DESIRED_DEFAULT_CONFIGURATION_REGISTER>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/DefaultConfigurationRegister/Reported { "value": <REPORTED_DEFAULT_CONFIGURATION_REGISTER>}

\subsection door_lock_attr_enable_local_programming DoorLock/EnableLocalProgramming Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/EnableLocalProgramming/Reported
[PREFIX]/DoorLock/Attributes/EnableLocalProgramming/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster EnableLocalProgramming Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "boolean"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for EnableLocalProgramming attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/EnableLocalProgramming/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/EnableLocalProgramming/Desired { "value": <DESIRED_ENABLE_LOCAL_PROGRAMMING>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/EnableLocalProgramming/Reported { "value": <REPORTED_ENABLE_LOCAL_PROGRAMMING>}

\subsection door_lock_attr_enable_one_touch_locking DoorLock/EnableOneTouchLocking Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/EnableOneTouchLocking/Reported
[PREFIX]/DoorLock/Attributes/EnableOneTouchLocking/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster EnableOneTouchLocking Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "boolean"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for EnableOneTouchLocking attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/EnableOneTouchLocking/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/EnableOneTouchLocking/Desired { "value": <DESIRED_ENABLE_ONE_TOUCH_LOCKING>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/EnableOneTouchLocking/Reported { "value": <REPORTED_ENABLE_ONE_TOUCH_LOCKING>}

\subsection door_lock_attr_enable_inside_statusled DoorLock/EnableInsideStatusLED Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/EnableInsideStatusLED/Reported
[PREFIX]/DoorLock/Attributes/EnableInsideStatusLED/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster EnableInsideStatusLED Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "boolean"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for EnableInsideStatusLED attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/EnableInsideStatusLED/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/EnableInsideStatusLED/Desired { "value": <DESIRED_ENABLE_INSIDE_STATUSLED>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/EnableInsideStatusLED/Reported { "value": <REPORTED_ENABLE_INSIDE_STATUSLED>}

\subsection door_lock_attr_enable_privacy_mode_button DoorLock/EnablePrivacyModeButton Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/EnablePrivacyModeButton/Reported
[PREFIX]/DoorLock/Attributes/EnablePrivacyModeButton/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster EnablePrivacyModeButton Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "boolean"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for EnablePrivacyModeButton attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/EnablePrivacyModeButton/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/EnablePrivacyModeButton/Desired { "value": <DESIRED_ENABLE_PRIVACY_MODE_BUTTON>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/EnablePrivacyModeButton/Reported { "value": <REPORTED_ENABLE_PRIVACY_MODE_BUTTON>}

\subsection door_lock_attr_local_programming_features DoorLock/LocalProgrammingFeatures Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/LocalProgrammingFeatures/Reported
[PREFIX]/DoorLock/Attributes/LocalProgrammingFeatures/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster LocalProgrammingFeatures Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "DoorLockLocalProgrammingFeatures"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for LocalProgrammingFeatures attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/LocalProgrammingFeatures/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/LocalProgrammingFeatures/Desired { "value": <DESIRED_LOCAL_PROGRAMMING_FEATURES>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/LocalProgrammingFeatures/Reported { "value": <REPORTED_LOCAL_PROGRAMMING_FEATURES>}

\subsection door_lock_attr_wrong_code_entry_limit DoorLock/WrongCodeEntryLimit Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/WrongCodeEntryLimit/Reported
[PREFIX]/DoorLock/Attributes/WrongCodeEntryLimit/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster WrongCodeEntryLimit Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for WrongCodeEntryLimit attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/WrongCodeEntryLimit/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/WrongCodeEntryLimit/Desired { "value": <DESIRED_WRONG_CODE_ENTRY_LIMIT>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/WrongCodeEntryLimit/Reported { "value": <REPORTED_WRONG_CODE_ENTRY_LIMIT>}

\subsection door_lock_attr_user_code_temporary_disable_time DoorLock/UserCodeTemporaryDisableTime Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/UserCodeTemporaryDisableTime/Reported
[PREFIX]/DoorLock/Attributes/UserCodeTemporaryDisableTime/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster UserCodeTemporaryDisableTime Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for UserCodeTemporaryDisableTime attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/UserCodeTemporaryDisableTime/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/UserCodeTemporaryDisableTime/Desired { "value": <DESIRED_USER_CODE_TEMPORARY_DISABLE_TIME>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/UserCodeTemporaryDisableTime/Reported { "value": <REPORTED_USER_CODE_TEMPORARY_DISABLE_TIME>}

\subsection door_lock_attr_send_pin_over_the_air DoorLock/SendPINOverTheAir Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/SendPINOverTheAir/Reported
[PREFIX]/DoorLock/Attributes/SendPINOverTheAir/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster SendPINOverTheAir Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "boolean"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for SendPINOverTheAir attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/SendPINOverTheAir/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/SendPINOverTheAir/Desired { "value": <DESIRED_SEND_PIN_OVER_THE_AIR>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/SendPINOverTheAir/Reported { "value": <REPORTED_SEND_PIN_OVER_THE_AIR>}

\subsection door_lock_attr_require_pi_nfor_rf_operation DoorLock/RequirePINforRFOperation Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/RequirePINforRFOperation/Reported
[PREFIX]/DoorLock/Attributes/RequirePINforRFOperation/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster RequirePINforRFOperation Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "boolean"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RequirePINforRFOperation attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/RequirePINforRFOperation/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/RequirePINforRFOperation/Desired { "value": <DESIRED_REQUIRE_PI_NFOR_RF_OPERATION>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/RequirePINforRFOperation/Reported { "value": <REPORTED_REQUIRE_PI_NFOR_RF_OPERATION>}

\subsection door_lock_attr_security_level DoorLock/SecurityLevel Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/SecurityLevel/Reported
[PREFIX]/DoorLock/Attributes/SecurityLevel/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster SecurityLevel Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "DoorLockSecurityLevel"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for SecurityLevel attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/SecurityLevel/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/SecurityLevel/Desired { "value": <DESIRED_SECURITY_LEVEL>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/SecurityLevel/Reported { "value": <REPORTED_SECURITY_LEVEL>}

\subsection door_lock_attr_expiring_user_timeout DoorLock/ExpiringUserTimeout Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/ExpiringUserTimeout/Reported
[PREFIX]/DoorLock/Attributes/ExpiringUserTimeout/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ExpiringUserTimeout Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ExpiringUserTimeout attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/ExpiringUserTimeout/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/ExpiringUserTimeout/Desired { "value": <DESIRED_EXPIRING_USER_TIMEOUT>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/ExpiringUserTimeout/Reported { "value": <REPORTED_EXPIRING_USER_TIMEOUT>}

\subsection door_lock_attr_alarm_mask DoorLock/AlarmMask Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/AlarmMask/Reported
[PREFIX]/DoorLock/Attributes/AlarmMask/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster AlarmMask Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "DoorLockAlarmMask"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for AlarmMask attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/AlarmMask/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/AlarmMask/Desired { "value": <DESIRED_ALARM_MASK>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/AlarmMask/Reported { "value": <REPORTED_ALARM_MASK>}

\subsection door_lock_attr_keypad_operation_event_mask DoorLock/KeypadOperationEventMask Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/KeypadOperationEventMask/Reported
[PREFIX]/DoorLock/Attributes/KeypadOperationEventMask/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster KeypadOperationEventMask Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "DoorLockKeypadOperationEventMask"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for KeypadOperationEventMask attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/KeypadOperationEventMask/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/KeypadOperationEventMask/Desired { "value": <DESIRED_KEYPAD_OPERATION_EVENT_MASK>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/KeypadOperationEventMask/Reported { "value": <REPORTED_KEYPAD_OPERATION_EVENT_MASK>}

\subsection door_lock_attr_rf_operation_event_mask DoorLock/RFOperationEventMask Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/RFOperationEventMask/Reported
[PREFIX]/DoorLock/Attributes/RFOperationEventMask/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster RFOperationEventMask Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "DoorLockRFOperationEventMask"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RFOperationEventMask attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/RFOperationEventMask/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/RFOperationEventMask/Desired { "value": <DESIRED_RF_OPERATION_EVENT_MASK>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/RFOperationEventMask/Reported { "value": <REPORTED_RF_OPERATION_EVENT_MASK>}

\subsection door_lock_attr_manual_operation_event_mask DoorLock/ManualOperationEventMask Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/ManualOperationEventMask/Reported
[PREFIX]/DoorLock/Attributes/ManualOperationEventMask/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ManualOperationEventMask Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "DoorLockManualOperationEventMask"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ManualOperationEventMask attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/ManualOperationEventMask/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/ManualOperationEventMask/Desired { "value": <DESIRED_MANUAL_OPERATION_EVENT_MASK>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/ManualOperationEventMask/Reported { "value": <REPORTED_MANUAL_OPERATION_EVENT_MASK>}

\subsection door_lock_attr_rfid_operation_event_mask DoorLock/RFIDOperationEventMask Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/RFIDOperationEventMask/Reported
[PREFIX]/DoorLock/Attributes/RFIDOperationEventMask/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster RFIDOperationEventMask Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "DoorLockRFIDOperationEventMask"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RFIDOperationEventMask attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/RFIDOperationEventMask/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/RFIDOperationEventMask/Desired { "value": <DESIRED_RFID_OPERATION_EVENT_MASK>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/RFIDOperationEventMask/Reported { "value": <REPORTED_RFID_OPERATION_EVENT_MASK>}

\subsection door_lock_attr_keypad_programming_event_mask DoorLock/KeypadProgrammingEventMask Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/KeypadProgrammingEventMask/Reported
[PREFIX]/DoorLock/Attributes/KeypadProgrammingEventMask/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster KeypadProgrammingEventMask Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "DoorLockKeypadProgrammingEventMask"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for KeypadProgrammingEventMask attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/KeypadProgrammingEventMask/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/KeypadProgrammingEventMask/Desired { "value": <DESIRED_KEYPAD_PROGRAMMING_EVENT_MASK>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/KeypadProgrammingEventMask/Reported { "value": <REPORTED_KEYPAD_PROGRAMMING_EVENT_MASK>}

\subsection door_lock_attr_rf_programming_event_mask DoorLock/RFProgrammingEventMask Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/RFProgrammingEventMask/Reported
[PREFIX]/DoorLock/Attributes/RFProgrammingEventMask/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster RFProgrammingEventMask Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "DoorLockRFProgrammingEventMask"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RFProgrammingEventMask attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/RFProgrammingEventMask/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/RFProgrammingEventMask/Desired { "value": <DESIRED_RF_PROGRAMMING_EVENT_MASK>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/RFProgrammingEventMask/Reported { "value": <REPORTED_RF_PROGRAMMING_EVENT_MASK>}

\subsection door_lock_attr_rfid_programming_event_mask DoorLock/RFIDProgrammingEventMask Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/RFIDProgrammingEventMask/Reported
[PREFIX]/DoorLock/Attributes/RFIDProgrammingEventMask/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster RFIDProgrammingEventMask Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "DoorLockRFIDProgrammingEventMask"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RFIDProgrammingEventMask attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/RFIDProgrammingEventMask/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/RFIDProgrammingEventMask/Desired { "value": <DESIRED_RFID_PROGRAMMING_EVENT_MASK>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/RFIDProgrammingEventMask/Reported { "value": <REPORTED_RFID_PROGRAMMING_EVENT_MASK>}

\subsection door_lock_attr_feature_map DoorLock/FeatureMap Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/FeatureMap/Reported
[PREFIX]/DoorLock/Attributes/FeatureMap/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster FeatureMap Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "DoorLockFeatureMap"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for FeatureMap attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/FeatureMap/+'

# Example output

ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/FeatureMap/Desired { "value": <DESIRED_FEATURE_MAP>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/FeatureMap/Reported { "value": <REPORTED_FEATURE_MAP>}

\subsection door_lock_attr_cluster_revision DoorLock/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/ClusterRevision/Reported
[PREFIX]/DoorLock/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/DoorLock/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/DoorLock/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section door_lock_recv_cmd_support DoorLock Command Support

MQTT Topic Pattern:

[PREFIX]/DoorLock/SupportedCommands
[PREFIX]/DoorLock/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
              "LockDoor",
              "LockDoorResponse",
              "UnlockDoor",
              "UnlockDoorResponse",
              "Toggle",
              "ToggleResponse",
              "UnlockWithTimeout",
              "UnlockWithTimeoutResponse",
              "GetLogRecord",
              "GetLogRecordResponse",
              "SetPINCode",
              "SetPINCodeResponse",
              "GetPINCode",
              "GetPINCodeResponse",
              "ClearPINCode",
              "ClearPINCodeResponse",
              "ClearAllPINCodes",
              "ClearAllPINCodesResponse",
              "SetUserStatus",
              "SetUserStatusResponse",
              "GetUserStatus",
              "GetUserStatusResponse",
              "SetWeekdaySchedule",
              "SetWeekdayScheduleResponse",
              "GetWeekdaySchedule",
              "GetWeekdayScheduleResponse",
              "ClearWeekdaySchedule",
              "ClearWeekdayScheduleResponse",
              "SetYearDaySchedule",
              "SetYearDayScheduleResponse",
              "GetYearDaySchedule",
              "GetYearDayScheduleResponse",
              "ClearYearDaySchedule",
              "ClearYearDayScheduleResponse",
              "SetHolidaySchedule",
              "SetHolidayScheduleResponse",
              "GetHolidaySchedule",
              "GetHolidayScheduleResponse",
              "ClearHolidaySchedule",
              "ClearHolidayScheduleResponse",
              "SetUserType",
              "SetUserTypeResponse",
              "GetUserType",
              "GetUserTypeResponse",
              "SetRFIDCode",
              "SetRFIDCodeResponse",
              "GetRFIDCode",
              "GetRFIDCodeResponse",
              "ClearRFIDCode",
              "ClearRFIDCodeResponse",
              "ClearAllRFIDCodes",
              "ClearAllRFIDCodesResponse",
              "SetUser",
              "GetUser",
              "GetUserResponse",
              "ClearUser",
              "OperatingEventNotification",
              "ProgrammingEventNotification",
              "SetCredential",
              "SetCredentialResponse",
              "GetCredentialStatus",
              "GetCredentialStatusResponse",
              "ClearCredential",
              "UnboltDoor",
              "WriteAttributes",
              "ForceReadAttributes"
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for DoorLock cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/DoorLock/SupportedCommands { "value": ["LockDoor","UnlockDoor","Toggle","UnlockWithTimeout","GetLogRecord","SetPINCode","GetPINCode","ClearPINCode","ClearAllPINCodes","SetUserStatus","GetUserStatus","SetWeekdaySchedule","GetWeekdaySchedule","ClearWeekdaySchedule","SetYearDaySchedule","GetYearDaySchedule","ClearYearDaySchedule","SetHolidaySchedule","GetHolidaySchedule","ClearHolidaySchedule","SetUserType","GetUserType","SetRFIDCode","GetRFIDCode","ClearRFIDCode","ClearAllRFIDCodes","SetUser","GetUser","ClearUser","SetCredential","GetCredentialStatus","ClearCredential","UnboltDoor","WriteAttributes", "ForceReadAttributes"] }

To see supported generated commands for DoorLock cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/DoorLock/SupportedGeneratedCommands { "value": ["LockDoorResponse","UnlockDoorResponse","ToggleResponse","UnlockWithTimeoutResponse","GetLogRecordResponse","SetPINCodeResponse","GetPINCodeResponse","ClearPINCodeResponse","ClearAllPINCodesResponse","SetUserStatusResponse","GetUserStatusResponse","SetWeekdayScheduleResponse","GetWeekdayScheduleResponse","ClearWeekdayScheduleResponse","SetYearDayScheduleResponse","GetYearDayScheduleResponse","ClearYearDayScheduleResponse","SetHolidayScheduleResponse","GetHolidayScheduleResponse","ClearHolidayScheduleResponse","SetUserTypeResponse","GetUserTypeResponse","SetRFIDCodeResponse","GetRFIDCodeResponse","ClearRFIDCodeResponse","ClearAllRFIDCodesResponse","GetUserResponse","OperatingEventNotification","ProgrammingEventNotification","SetCredentialResponse","GetCredentialStatusResponse",] }

\section door_lock_cmds DoorLock Commands

\subsection door_lock_lock_door_cmd DoorLock/LockDoor Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/LockDoor
[PREFIX]/DoorLock/GeneratedCommands/LockDoor

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster LockDoor Command Properties",
  "type": "object",
  "properties": {
    "PINOrRFIDCode": {
      "type": "string"
    }
  },
  "required": [
    "PINOrRFIDCode"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/LockDoor command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/LockDoor' -m  '{ "PINOrRFIDCode": <PIN_OR_RFID_CODE_VALUE> }'

To receive a DoorLock/LockDoor generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/LockDoor'

\subsection door_lock_lock_door_response_cmd DoorLock/LockDoorResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/LockDoorResponse
[PREFIX]/DoorLock/GeneratedCommands/LockDoorResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster LockDoorResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "zclStatus"
    }
  },
  "required": [
    "Status"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/LockDoorResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/LockDoorResponse' -m  '{ "Status": <STATUS_VALUE> }'

To receive a DoorLock/LockDoorResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/LockDoorResponse'

\subsection door_lock_unlock_door_cmd DoorLock/UnlockDoor Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/UnlockDoor
[PREFIX]/DoorLock/GeneratedCommands/UnlockDoor

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster UnlockDoor Command Properties",
  "type": "object",
  "properties": {
    "PINOrRFIDCode": {
      "type": "string"
    }
  },
  "required": [
    "PINOrRFIDCode"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/UnlockDoor command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/UnlockDoor' -m  '{ "PINOrRFIDCode": <PIN_OR_RFID_CODE_VALUE> }'

To receive a DoorLock/UnlockDoor generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/UnlockDoor'

\subsection door_lock_unlock_door_response_cmd DoorLock/UnlockDoorResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/UnlockDoorResponse
[PREFIX]/DoorLock/GeneratedCommands/UnlockDoorResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster UnlockDoorResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "zclStatus"
    }
  },
  "required": [
    "Status"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/UnlockDoorResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/UnlockDoorResponse' -m  '{ "Status": <STATUS_VALUE> }'

To receive a DoorLock/UnlockDoorResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/UnlockDoorResponse'

\subsection door_lock_toggle_cmd DoorLock/Toggle Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/Toggle
[PREFIX]/DoorLock/GeneratedCommands/Toggle

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster Toggle Command Properties",
  "type": "object",
  "properties": {
    "PINOrRFIDCode": {
      "type": "string"
    }
  },
  "required": [
    "PINOrRFIDCode"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/Toggle command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/Toggle' -m  '{ "PINOrRFIDCode": <PIN_OR_RFID_CODE_VALUE> }'

To receive a DoorLock/Toggle generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/Toggle'

\subsection door_lock_toggle_response_cmd DoorLock/ToggleResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/ToggleResponse
[PREFIX]/DoorLock/GeneratedCommands/ToggleResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ToggleResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "zclStatus"
    }
  },
  "required": [
    "Status"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/ToggleResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/ToggleResponse' -m  '{ "Status": <STATUS_VALUE> }'

To receive a DoorLock/ToggleResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/ToggleResponse'

\subsection door_lock_unlock_with_timeout_cmd DoorLock/UnlockWithTimeout Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/UnlockWithTimeout
[PREFIX]/DoorLock/GeneratedCommands/UnlockWithTimeout

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster UnlockWithTimeout Command Properties",
  "type": "object",
  "properties": {
    "TimeoutInSeconds": {
      "type": "integer"
    },
    "PINOrRFIDCode": {
      "type": "string"
    }
  },
  "required": [
    "TimeoutInSeconds",
    "PINOrRFIDCode"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/UnlockWithTimeout command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/UnlockWithTimeout' -m  '{ "TimeoutInSeconds": <TIMEOUT_IN_SECONDS_VALUE>,"PINOrRFIDCode": <PIN_OR_RFID_CODE_VALUE> }'

To receive a DoorLock/UnlockWithTimeout generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/UnlockWithTimeout'

\subsection door_lock_unlock_with_timeout_response_cmd DoorLock/UnlockWithTimeoutResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/UnlockWithTimeoutResponse
[PREFIX]/DoorLock/GeneratedCommands/UnlockWithTimeoutResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster UnlockWithTimeoutResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "zclStatus"
    }
  },
  "required": [
    "Status"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/UnlockWithTimeoutResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/UnlockWithTimeoutResponse' -m  '{ "Status": <STATUS_VALUE> }'

To receive a DoorLock/UnlockWithTimeoutResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/UnlockWithTimeoutResponse'

\subsection door_lock_get_log_record_cmd DoorLock/GetLogRecord Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/GetLogRecord
[PREFIX]/DoorLock/GeneratedCommands/GetLogRecord

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster GetLogRecord Command Properties",
  "type": "object",
  "properties": {
    "LogIndex": {
      "type": "integer"
    }
  },
  "required": [
    "LogIndex"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/GetLogRecord command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/GetLogRecord' -m  '{ "LogIndex": <LOG_INDEX_VALUE> }'

To receive a DoorLock/GetLogRecord generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/GetLogRecord'

\subsection door_lock_get_log_record_response_cmd DoorLock/GetLogRecordResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/GetLogRecordResponse
[PREFIX]/DoorLock/GeneratedCommands/GetLogRecordResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster GetLogRecordResponse Command Properties",
  "type": "object",
  "properties": {
    "LogEntryID": {
      "type": "integer"
    },
    "Timestamp": {
      "type": "integer"
    },
    "EventType": {
      "type": "GetLogRecordResponseEventType"
    },
    "SourceOperationEvent": {
      "type": "DrlkOperEventSource"
    },
    "EventIDOrAlarmCode": {
      "type": "integer"
    },
    "UserID": {
      "type": "integer"
    },
    "PIN": {
      "type": "string"
    }
  },
  "required": [
    "LogEntryID",
    "Timestamp",
    "EventType",
    "SourceOperationEvent",
    "EventIDOrAlarmCode",
    "UserID",
    "PIN"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/GetLogRecordResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/GetLogRecordResponse' -m  '{ "LogEntryID": <LOG_ENTRYID_VALUE>,"Timestamp": <TIMESTAMP_VALUE>,"EventType": <EVENT_TYPE_VALUE>,"SourceOperationEvent": <SOURCE_OPERATION_EVENT_VALUE>,"EventIDOrAlarmCode": <EVENT_ID_OR_ALARM_CODE_VALUE>,"UserID": <USERID_VALUE>,"PIN": <PIN_VALUE> }'

To receive a DoorLock/GetLogRecordResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/GetLogRecordResponse'

\subsection door_lock_set_pin_code_cmd DoorLock/SetPINCode Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/SetPINCode
[PREFIX]/DoorLock/GeneratedCommands/SetPINCode

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster SetPINCode Command Properties",
  "type": "object",
  "properties": {
    "UserID": {
      "type": "DrlkPINUserID"
    },
    "UserStatus": {
      "type": "DrlkSettableUserStatus"
    },
    "UserType": {
      "type": "DrlkUserType"
    },
    "PIN": {
      "type": "string"
    }
  },
  "required": [
    "UserID",
    "UserStatus",
    "UserType",
    "PIN"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/SetPINCode command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/SetPINCode' -m  '{ "UserID": <USERID_VALUE>,"UserStatus": <USER_STATUS_VALUE>,"UserType": <USER_TYPE_VALUE>,"PIN": <PIN_VALUE> }'

To receive a DoorLock/SetPINCode generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/SetPINCode'

\subsection door_lock_set_pin_code_response_cmd DoorLock/SetPINCodeResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/SetPINCodeResponse
[PREFIX]/DoorLock/GeneratedCommands/SetPINCodeResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster SetPINCodeResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "DrlkSetCodeStatus"
    }
  },
  "required": [
    "Status"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/SetPINCodeResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/SetPINCodeResponse' -m  '{ "Status": <STATUS_VALUE> }'

To receive a DoorLock/SetPINCodeResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/SetPINCodeResponse'

\subsection door_lock_get_pin_code_cmd DoorLock/GetPINCode Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/GetPINCode
[PREFIX]/DoorLock/GeneratedCommands/GetPINCode

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster GetPINCode Command Properties",
  "type": "object",
  "properties": {
    "UserID": {
      "type": "DrlkPINUserID"
    }
  },
  "required": [
    "UserID"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/GetPINCode command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/GetPINCode' -m  '{ "UserID": <USERID_VALUE> }'

To receive a DoorLock/GetPINCode generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/GetPINCode'

\subsection door_lock_get_pin_code_response_cmd DoorLock/GetPINCodeResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/GetPINCodeResponse
[PREFIX]/DoorLock/GeneratedCommands/GetPINCodeResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster GetPINCodeResponse Command Properties",
  "type": "object",
  "properties": {
    "UserID": {
      "type": "integer"
    },
    "UserStatus": {
      "type": "DrlkUserStatus"
    },
    "UserType": {
      "type": "DrlkUserType"
    },
    "Code": {
      "type": "string"
    }
  },
  "required": [
    "UserID",
    "UserStatus",
    "UserType",
    "Code"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/GetPINCodeResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/GetPINCodeResponse' -m  '{ "UserID": <USERID_VALUE>,"UserStatus": <USER_STATUS_VALUE>,"UserType": <USER_TYPE_VALUE>,"Code": <CODE_VALUE> }'

To receive a DoorLock/GetPINCodeResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/GetPINCodeResponse'

\subsection door_lock_clear_pin_code_cmd DoorLock/ClearPINCode Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/ClearPINCode
[PREFIX]/DoorLock/GeneratedCommands/ClearPINCode

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ClearPINCode Command Properties",
  "type": "object",
  "properties": {
    "UserID": {
      "type": "DrlkPINUserID"
    }
  },
  "required": [
    "UserID"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/ClearPINCode command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/ClearPINCode' -m  '{ "UserID": <USERID_VALUE> }'

To receive a DoorLock/ClearPINCode generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/ClearPINCode'

\subsection door_lock_clear_pin_code_response_cmd DoorLock/ClearPINCodeResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/ClearPINCodeResponse
[PREFIX]/DoorLock/GeneratedCommands/ClearPINCodeResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ClearPINCodeResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "DrlkPassFailStatus"
    }
  },
  "required": [
    "Status"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/ClearPINCodeResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/ClearPINCodeResponse' -m  '{ "Status": <STATUS_VALUE> }'

To receive a DoorLock/ClearPINCodeResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/ClearPINCodeResponse'

\subsection door_lock_clear_all_pin_codes_cmd DoorLock/ClearAllPINCodes Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/ClearAllPINCodes
[PREFIX]/DoorLock/GeneratedCommands/ClearAllPINCodes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ClearAllPINCodes Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/ClearAllPINCodes command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/ClearAllPINCodes' -m  '{  }'

To receive a DoorLock/ClearAllPINCodes generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/ClearAllPINCodes'

\subsection door_lock_clear_all_pin_codes_response_cmd DoorLock/ClearAllPINCodesResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/ClearAllPINCodesResponse
[PREFIX]/DoorLock/GeneratedCommands/ClearAllPINCodesResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ClearAllPINCodesResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "DrlkPassFailStatus"
    }
  },
  "required": [
    "Status"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/ClearAllPINCodesResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/ClearAllPINCodesResponse' -m  '{ "Status": <STATUS_VALUE> }'

To receive a DoorLock/ClearAllPINCodesResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/ClearAllPINCodesResponse'

\subsection door_lock_set_user_status_cmd DoorLock/SetUserStatus Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/SetUserStatus
[PREFIX]/DoorLock/GeneratedCommands/SetUserStatus

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster SetUserStatus Command Properties",
  "type": "object",
  "properties": {
    "UserID": {
      "type": "DrlkTotalUserID"
    },
    "UserStatus": {
      "type": "DrlkSettableUserStatus"
    }
  },
  "required": [
    "UserID",
    "UserStatus"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/SetUserStatus command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/SetUserStatus' -m  '{ "UserID": <USERID_VALUE>,"UserStatus": <USER_STATUS_VALUE> }'

To receive a DoorLock/SetUserStatus generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/SetUserStatus'

\subsection door_lock_set_user_status_response_cmd DoorLock/SetUserStatusResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/SetUserStatusResponse
[PREFIX]/DoorLock/GeneratedCommands/SetUserStatusResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster SetUserStatusResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "DrlkPassFailStatus"
    }
  },
  "required": [
    "Status"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/SetUserStatusResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/SetUserStatusResponse' -m  '{ "Status": <STATUS_VALUE> }'

To receive a DoorLock/SetUserStatusResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/SetUserStatusResponse'

\subsection door_lock_get_user_status_cmd DoorLock/GetUserStatus Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/GetUserStatus
[PREFIX]/DoorLock/GeneratedCommands/GetUserStatus

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster GetUserStatus Command Properties",
  "type": "object",
  "properties": {
    "UserID": {
      "type": "DrlkTotalUserID"
    }
  },
  "required": [
    "UserID"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/GetUserStatus command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/GetUserStatus' -m  '{ "UserID": <USERID_VALUE> }'

To receive a DoorLock/GetUserStatus generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/GetUserStatus'

\subsection door_lock_get_user_status_response_cmd DoorLock/GetUserStatusResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/GetUserStatusResponse
[PREFIX]/DoorLock/GeneratedCommands/GetUserStatusResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster GetUserStatusResponse Command Properties",
  "type": "object",
  "properties": {
    "UserID": {
      "type": "integer"
    },
    "UserStatus": {
      "type": "DrlkUserStatus"
    }
  },
  "required": [
    "UserID",
    "UserStatus"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/GetUserStatusResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/GetUserStatusResponse' -m  '{ "UserID": <USERID_VALUE>,"UserStatus": <USER_STATUS_VALUE> }'

To receive a DoorLock/GetUserStatusResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/GetUserStatusResponse'

\subsection door_lock_set_weekday_schedule_cmd DoorLock/SetWeekdaySchedule Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/SetWeekdaySchedule
[PREFIX]/DoorLock/GeneratedCommands/SetWeekdaySchedule

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster SetWeekdaySchedule Command Properties",
  "type": "object",
  "properties": {
    "ScheduleID": {
      "type": "DrlkWeekDayScheduleID"
    },
    "UserID": {
      "type": "DrlkTotalUserID"
    },
    "DaysMask": {
      "type": "DrlkDaysMask"
    },
    "StartHour": {
      "type": "integer"
    },
    "StartMinute": {
      "type": "integer"
    },
    "EndHour": {
      "type": "integer"
    },
    "EndMinute": {
      "type": "integer"
    }
  },
  "required": [
    "ScheduleID",
    "UserID",
    "DaysMask",
    "StartHour",
    "StartMinute",
    "EndHour",
    "EndMinute"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/SetWeekdaySchedule command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/SetWeekdaySchedule' -m  '{ "ScheduleID": <SCHEDULEID_VALUE>,"UserID": <USERID_VALUE>,"DaysMask": <DAYS_MASK_VALUE>,"StartHour": <START_HOUR_VALUE>,"StartMinute": <START_MINUTE_VALUE>,"EndHour": <END_HOUR_VALUE>,"EndMinute": <END_MINUTE_VALUE> }'

To receive a DoorLock/SetWeekdaySchedule generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/SetWeekdaySchedule'

\subsection door_lock_set_weekday_schedule_response_cmd DoorLock/SetWeekdayScheduleResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/SetWeekdayScheduleResponse
[PREFIX]/DoorLock/GeneratedCommands/SetWeekdayScheduleResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster SetWeekdayScheduleResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "DrlkPassFailStatus"
    }
  },
  "required": [
    "Status"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/SetWeekdayScheduleResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/SetWeekdayScheduleResponse' -m  '{ "Status": <STATUS_VALUE> }'

To receive a DoorLock/SetWeekdayScheduleResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/SetWeekdayScheduleResponse'

\subsection door_lock_get_weekday_schedule_cmd DoorLock/GetWeekdaySchedule Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/GetWeekdaySchedule
[PREFIX]/DoorLock/GeneratedCommands/GetWeekdaySchedule

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster GetWeekdaySchedule Command Properties",
  "type": "object",
  "properties": {
    "ScheduleID": {
      "type": "DrlkWeekDayScheduleID"
    },
    "UserID": {
      "type": "DrlkTotalUserID"
    }
  },
  "required": [
    "ScheduleID",
    "UserID"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/GetWeekdaySchedule command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/GetWeekdaySchedule' -m  '{ "ScheduleID": <SCHEDULEID_VALUE>,"UserID": <USERID_VALUE> }'

To receive a DoorLock/GetWeekdaySchedule generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/GetWeekdaySchedule'

\subsection door_lock_get_weekday_schedule_response_cmd DoorLock/GetWeekdayScheduleResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/GetWeekdayScheduleResponse
[PREFIX]/DoorLock/GeneratedCommands/GetWeekdayScheduleResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster GetWeekdayScheduleResponse Command Properties",
  "type": "object",
  "properties": {
    "ScheduleID": {
      "type": "integer"
    },
    "UserID": {
      "type": "integer"
    },
    "Status": {
      "type": "zclStatus"
    },
    "DaysMask": {
      "type": "DrlkDaysMask"
    },
    "StartHour": {
      "type": "integer"
    },
    "StartMinute": {
      "type": "integer"
    },
    "EndHour": {
      "type": "integer"
    },
    "EndMinute": {
      "type": "integer"
    }
  },
  "required": [
    "ScheduleID",
    "UserID",
    "Status",
    "DaysMask",
    "StartHour",
    "StartMinute",
    "EndHour",
    "EndMinute"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/GetWeekdayScheduleResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/GetWeekdayScheduleResponse' -m  '{ "ScheduleID": <SCHEDULEID_VALUE>,"UserID": <USERID_VALUE>,"Status": <STATUS_VALUE>,"DaysMask": <DAYS_MASK_VALUE>,"StartHour": <START_HOUR_VALUE>,"StartMinute": <START_MINUTE_VALUE>,"EndHour": <END_HOUR_VALUE>,"EndMinute": <END_MINUTE_VALUE> }'

To receive a DoorLock/GetWeekdayScheduleResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/GetWeekdayScheduleResponse'

\subsection door_lock_clear_weekday_schedule_cmd DoorLock/ClearWeekdaySchedule Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/ClearWeekdaySchedule
[PREFIX]/DoorLock/GeneratedCommands/ClearWeekdaySchedule

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ClearWeekdaySchedule Command Properties",
  "type": "object",
  "properties": {
    "ScheduleID": {
      "type": "DrlkWeekDayScheduleID"
    },
    "UserID": {
      "type": "DrlkTotalUserID"
    }
  },
  "required": [
    "ScheduleID",
    "UserID"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/ClearWeekdaySchedule command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/ClearWeekdaySchedule' -m  '{ "ScheduleID": <SCHEDULEID_VALUE>,"UserID": <USERID_VALUE> }'

To receive a DoorLock/ClearWeekdaySchedule generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/ClearWeekdaySchedule'

\subsection door_lock_clear_weekday_schedule_response_cmd DoorLock/ClearWeekdayScheduleResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/ClearWeekdayScheduleResponse
[PREFIX]/DoorLock/GeneratedCommands/ClearWeekdayScheduleResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ClearWeekdayScheduleResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "DrlkPassFailStatus"
    }
  },
  "required": [
    "Status"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/ClearWeekdayScheduleResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/ClearWeekdayScheduleResponse' -m  '{ "Status": <STATUS_VALUE> }'

To receive a DoorLock/ClearWeekdayScheduleResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/ClearWeekdayScheduleResponse'

\subsection door_lock_set_year_day_schedule_cmd DoorLock/SetYearDaySchedule Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/SetYearDaySchedule
[PREFIX]/DoorLock/GeneratedCommands/SetYearDaySchedule

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster SetYearDaySchedule Command Properties",
  "type": "object",
  "properties": {
    "ScheduleID": {
      "type": "DrlkYearDayScheduleID"
    },
    "UserID": {
      "type": "DrlkTotalUserID"
    },
    "LocalStartTime": {
      "type": "integer"
    },
    "LocalEndTime": {
      "type": "integer"
    }
  },
  "required": [
    "ScheduleID",
    "UserID",
    "LocalStartTime",
    "LocalEndTime"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/SetYearDaySchedule command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/SetYearDaySchedule' -m  '{ "ScheduleID": <SCHEDULEID_VALUE>,"UserID": <USERID_VALUE>,"LocalStartTime": <LOCAL_START_TIME_VALUE>,"LocalEndTime": <LOCAL_END_TIME_VALUE> }'

To receive a DoorLock/SetYearDaySchedule generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/SetYearDaySchedule'

\subsection door_lock_set_year_day_schedule_response_cmd DoorLock/SetYearDayScheduleResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/SetYearDayScheduleResponse
[PREFIX]/DoorLock/GeneratedCommands/SetYearDayScheduleResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster SetYearDayScheduleResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "DrlkPassFailStatus"
    }
  },
  "required": [
    "Status"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/SetYearDayScheduleResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/SetYearDayScheduleResponse' -m  '{ "Status": <STATUS_VALUE> }'

To receive a DoorLock/SetYearDayScheduleResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/SetYearDayScheduleResponse'

\subsection door_lock_get_year_day_schedule_cmd DoorLock/GetYearDaySchedule Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/GetYearDaySchedule
[PREFIX]/DoorLock/GeneratedCommands/GetYearDaySchedule

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster GetYearDaySchedule Command Properties",
  "type": "object",
  "properties": {
    "ScheduleID": {
      "type": "DrlkYearDayScheduleID"
    },
    "UserID": {
      "type": "DrlkTotalUserID"
    }
  },
  "required": [
    "ScheduleID",
    "UserID"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/GetYearDaySchedule command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/GetYearDaySchedule' -m  '{ "ScheduleID": <SCHEDULEID_VALUE>,"UserID": <USERID_VALUE> }'

To receive a DoorLock/GetYearDaySchedule generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/GetYearDaySchedule'

\subsection door_lock_get_year_day_schedule_response_cmd DoorLock/GetYearDayScheduleResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/GetYearDayScheduleResponse
[PREFIX]/DoorLock/GeneratedCommands/GetYearDayScheduleResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster GetYearDayScheduleResponse Command Properties",
  "type": "object",
  "properties": {
    "ScheduleID": {
      "type": "integer"
    },
    "UserID": {
      "type": "integer"
    },
    "Status": {
      "type": "zclStatus"
    },
    "LocalStartTime": {
      "type": "integer"
    },
    "LocalEndTime": {
      "type": "integer"
    }
  },
  "required": [
    "ScheduleID",
    "UserID",
    "Status",
    "LocalStartTime",
    "LocalEndTime"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/GetYearDayScheduleResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/GetYearDayScheduleResponse' -m  '{ "ScheduleID": <SCHEDULEID_VALUE>,"UserID": <USERID_VALUE>,"Status": <STATUS_VALUE>,"LocalStartTime": <LOCAL_START_TIME_VALUE>,"LocalEndTime": <LOCAL_END_TIME_VALUE> }'

To receive a DoorLock/GetYearDayScheduleResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/GetYearDayScheduleResponse'

\subsection door_lock_clear_year_day_schedule_cmd DoorLock/ClearYearDaySchedule Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/ClearYearDaySchedule
[PREFIX]/DoorLock/GeneratedCommands/ClearYearDaySchedule

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ClearYearDaySchedule Command Properties",
  "type": "object",
  "properties": {
    "ScheduleID": {
      "type": "DrlkYearDayScheduleID"
    },
    "UserID": {
      "type": "DrlkTotalUserID"
    }
  },
  "required": [
    "ScheduleID",
    "UserID"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/ClearYearDaySchedule command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/ClearYearDaySchedule' -m  '{ "ScheduleID": <SCHEDULEID_VALUE>,"UserID": <USERID_VALUE> }'

To receive a DoorLock/ClearYearDaySchedule generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/ClearYearDaySchedule'

\subsection door_lock_clear_year_day_schedule_response_cmd DoorLock/ClearYearDayScheduleResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/ClearYearDayScheduleResponse
[PREFIX]/DoorLock/GeneratedCommands/ClearYearDayScheduleResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ClearYearDayScheduleResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "DrlkPassFailStatus"
    }
  },
  "required": [
    "Status"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/ClearYearDayScheduleResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/ClearYearDayScheduleResponse' -m  '{ "Status": <STATUS_VALUE> }'

To receive a DoorLock/ClearYearDayScheduleResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/ClearYearDayScheduleResponse'

\subsection door_lock_set_holiday_schedule_cmd DoorLock/SetHolidaySchedule Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/SetHolidaySchedule
[PREFIX]/DoorLock/GeneratedCommands/SetHolidaySchedule

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster SetHolidaySchedule Command Properties",
  "type": "object",
  "properties": {
    "HolidayScheduleID": {
      "type": "DrlkHolidayScheduleID"
    },
    "LocalStartTime": {
      "type": "integer"
    },
    "LocalEndTime": {
      "type": "integer"
    },
    "OperatingModeDuringHoliday": {
      "type": "DrlkOperMode"
    }
  },
  "required": [
    "HolidayScheduleID",
    "LocalStartTime",
    "LocalEndTime",
    "OperatingModeDuringHoliday"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/SetHolidaySchedule command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/SetHolidaySchedule' -m  '{ "HolidayScheduleID": <HOLIDAY_SCHEDULEID_VALUE>,"LocalStartTime": <LOCAL_START_TIME_VALUE>,"LocalEndTime": <LOCAL_END_TIME_VALUE>,"OperatingModeDuringHoliday": <OPERATING_MODE_DURING_HOLIDAY_VALUE> }'

To receive a DoorLock/SetHolidaySchedule generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/SetHolidaySchedule'

\subsection door_lock_set_holiday_schedule_response_cmd DoorLock/SetHolidayScheduleResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/SetHolidayScheduleResponse
[PREFIX]/DoorLock/GeneratedCommands/SetHolidayScheduleResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster SetHolidayScheduleResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "DrlkPassFailStatus"
    }
  },
  "required": [
    "Status"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/SetHolidayScheduleResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/SetHolidayScheduleResponse' -m  '{ "Status": <STATUS_VALUE> }'

To receive a DoorLock/SetHolidayScheduleResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/SetHolidayScheduleResponse'

\subsection door_lock_get_holiday_schedule_cmd DoorLock/GetHolidaySchedule Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/GetHolidaySchedule
[PREFIX]/DoorLock/GeneratedCommands/GetHolidaySchedule

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster GetHolidaySchedule Command Properties",
  "type": "object",
  "properties": {
    "HolidayScheduleID": {
      "type": "DrlkHolidayScheduleID"
    }
  },
  "required": [
    "HolidayScheduleID"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/GetHolidaySchedule command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/GetHolidaySchedule' -m  '{ "HolidayScheduleID": <HOLIDAY_SCHEDULEID_VALUE> }'

To receive a DoorLock/GetHolidaySchedule generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/GetHolidaySchedule'

\subsection door_lock_get_holiday_schedule_response_cmd DoorLock/GetHolidayScheduleResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/GetHolidayScheduleResponse
[PREFIX]/DoorLock/GeneratedCommands/GetHolidayScheduleResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster GetHolidayScheduleResponse Command Properties",
  "type": "object",
  "properties": {
    "HolidayScheduleID": {
      "type": "integer"
    },
    "Status": {
      "type": "zclStatus"
    },
    "LocalStartTime": {
      "type": "integer"
    },
    "LocalEndTime": {
      "type": "integer"
    },
    "OperatingModeDuringHoliday": {
      "type": "DrlkOperMode"
    }
  },
  "required": [
    "HolidayScheduleID",
    "Status",
    "LocalStartTime",
    "LocalEndTime",
    "OperatingModeDuringHoliday"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/GetHolidayScheduleResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/GetHolidayScheduleResponse' -m  '{ "HolidayScheduleID": <HOLIDAY_SCHEDULEID_VALUE>,"Status": <STATUS_VALUE>,"LocalStartTime": <LOCAL_START_TIME_VALUE>,"LocalEndTime": <LOCAL_END_TIME_VALUE>,"OperatingModeDuringHoliday": <OPERATING_MODE_DURING_HOLIDAY_VALUE> }'

To receive a DoorLock/GetHolidayScheduleResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/GetHolidayScheduleResponse'

\subsection door_lock_clear_holiday_schedule_cmd DoorLock/ClearHolidaySchedule Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/ClearHolidaySchedule
[PREFIX]/DoorLock/GeneratedCommands/ClearHolidaySchedule

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ClearHolidaySchedule Command Properties",
  "type": "object",
  "properties": {
    "HolidayScheduleID": {
      "type": "DrlkHolidayScheduleID"
    }
  },
  "required": [
    "HolidayScheduleID"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/ClearHolidaySchedule command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/ClearHolidaySchedule' -m  '{ "HolidayScheduleID": <HOLIDAY_SCHEDULEID_VALUE> }'

To receive a DoorLock/ClearHolidaySchedule generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/ClearHolidaySchedule'

\subsection door_lock_clear_holiday_schedule_response_cmd DoorLock/ClearHolidayScheduleResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/ClearHolidayScheduleResponse
[PREFIX]/DoorLock/GeneratedCommands/ClearHolidayScheduleResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ClearHolidayScheduleResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "DrlkPassFailStatus"
    }
  },
  "required": [
    "Status"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/ClearHolidayScheduleResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/ClearHolidayScheduleResponse' -m  '{ "Status": <STATUS_VALUE> }'

To receive a DoorLock/ClearHolidayScheduleResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/ClearHolidayScheduleResponse'

\subsection door_lock_set_user_type_cmd DoorLock/SetUserType Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/SetUserType
[PREFIX]/DoorLock/GeneratedCommands/SetUserType

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster SetUserType Command Properties",
  "type": "object",
  "properties": {
    "UserID": {
      "type": "DrlkTotalUserID"
    },
    "UserType": {
      "type": "DrlkUserType"
    }
  },
  "required": [
    "UserID",
    "UserType"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/SetUserType command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/SetUserType' -m  '{ "UserID": <USERID_VALUE>,"UserType": <USER_TYPE_VALUE> }'

To receive a DoorLock/SetUserType generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/SetUserType'

\subsection door_lock_set_user_type_response_cmd DoorLock/SetUserTypeResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/SetUserTypeResponse
[PREFIX]/DoorLock/GeneratedCommands/SetUserTypeResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster SetUserTypeResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "DrlkPassFailStatus"
    }
  },
  "required": [
    "Status"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/SetUserTypeResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/SetUserTypeResponse' -m  '{ "Status": <STATUS_VALUE> }'

To receive a DoorLock/SetUserTypeResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/SetUserTypeResponse'

\subsection door_lock_get_user_type_cmd DoorLock/GetUserType Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/GetUserType
[PREFIX]/DoorLock/GeneratedCommands/GetUserType

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster GetUserType Command Properties",
  "type": "object",
  "properties": {
    "UserID": {
      "type": "DrlkTotalUserID"
    }
  },
  "required": [
    "UserID"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/GetUserType command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/GetUserType' -m  '{ "UserID": <USERID_VALUE> }'

To receive a DoorLock/GetUserType generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/GetUserType'

\subsection door_lock_get_user_type_response_cmd DoorLock/GetUserTypeResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/GetUserTypeResponse
[PREFIX]/DoorLock/GeneratedCommands/GetUserTypeResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster GetUserTypeResponse Command Properties",
  "type": "object",
  "properties": {
    "UserID": {
      "type": "integer"
    },
    "UserType": {
      "type": "DrlkUserType"
    }
  },
  "required": [
    "UserID",
    "UserType"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/GetUserTypeResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/GetUserTypeResponse' -m  '{ "UserID": <USERID_VALUE>,"UserType": <USER_TYPE_VALUE> }'

To receive a DoorLock/GetUserTypeResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/GetUserTypeResponse'

\subsection door_lock_set_rfid_code_cmd DoorLock/SetRFIDCode Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/SetRFIDCode
[PREFIX]/DoorLock/GeneratedCommands/SetRFIDCode

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster SetRFIDCode Command Properties",
  "type": "object",
  "properties": {
    "UserID": {
      "type": "DrlkRFIDUserID"
    },
    "UserStatus": {
      "type": "DrlkSettableUserStatus"
    },
    "UserType": {
      "type": "DrlkUserType"
    },
    "RFIDCode": {
      "type": "string"
    }
  },
  "required": [
    "UserID",
    "UserStatus",
    "UserType",
    "RFIDCode"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/SetRFIDCode command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/SetRFIDCode' -m  '{ "UserID": <USERID_VALUE>,"UserStatus": <USER_STATUS_VALUE>,"UserType": <USER_TYPE_VALUE>,"RFIDCode": <RFID_CODE_VALUE> }'

To receive a DoorLock/SetRFIDCode generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/SetRFIDCode'

\subsection door_lock_set_rfid_code_response_cmd DoorLock/SetRFIDCodeResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/SetRFIDCodeResponse
[PREFIX]/DoorLock/GeneratedCommands/SetRFIDCodeResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster SetRFIDCodeResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "DrlkSetCodeStatus"
    }
  },
  "required": [
    "Status"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/SetRFIDCodeResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/SetRFIDCodeResponse' -m  '{ "Status": <STATUS_VALUE> }'

To receive a DoorLock/SetRFIDCodeResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/SetRFIDCodeResponse'

\subsection door_lock_get_rfid_code_cmd DoorLock/GetRFIDCode Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/GetRFIDCode
[PREFIX]/DoorLock/GeneratedCommands/GetRFIDCode

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster GetRFIDCode Command Properties",
  "type": "object",
  "properties": {
    "UserID": {
      "type": "DrlkRFIDUserID"
    }
  },
  "required": [
    "UserID"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/GetRFIDCode command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/GetRFIDCode' -m  '{ "UserID": <USERID_VALUE> }'

To receive a DoorLock/GetRFIDCode generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/GetRFIDCode'

\subsection door_lock_get_rfid_code_response_cmd DoorLock/GetRFIDCodeResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/GetRFIDCodeResponse
[PREFIX]/DoorLock/GeneratedCommands/GetRFIDCodeResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster GetRFIDCodeResponse Command Properties",
  "type": "object",
  "properties": {
    "UserID": {
      "type": "integer"
    },
    "UserStatus": {
      "type": "DrlkUserStatus"
    },
    "UserType": {
      "type": "DrlkUserType"
    },
    "RFIDCode": {
      "type": "string"
    }
  },
  "required": [
    "UserID",
    "UserStatus",
    "UserType",
    "RFIDCode"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/GetRFIDCodeResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/GetRFIDCodeResponse' -m  '{ "UserID": <USERID_VALUE>,"UserStatus": <USER_STATUS_VALUE>,"UserType": <USER_TYPE_VALUE>,"RFIDCode": <RFID_CODE_VALUE> }'

To receive a DoorLock/GetRFIDCodeResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/GetRFIDCodeResponse'

\subsection door_lock_clear_rfid_code_cmd DoorLock/ClearRFIDCode Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/ClearRFIDCode
[PREFIX]/DoorLock/GeneratedCommands/ClearRFIDCode

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ClearRFIDCode Command Properties",
  "type": "object",
  "properties": {
    "UserID": {
      "type": "DrlkRFIDUserID"
    }
  },
  "required": [
    "UserID"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/ClearRFIDCode command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/ClearRFIDCode' -m  '{ "UserID": <USERID_VALUE> }'

To receive a DoorLock/ClearRFIDCode generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/ClearRFIDCode'

\subsection door_lock_clear_rfid_code_response_cmd DoorLock/ClearRFIDCodeResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/ClearRFIDCodeResponse
[PREFIX]/DoorLock/GeneratedCommands/ClearRFIDCodeResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ClearRFIDCodeResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "DrlkPassFailStatus"
    }
  },
  "required": [
    "Status"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/ClearRFIDCodeResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/ClearRFIDCodeResponse' -m  '{ "Status": <STATUS_VALUE> }'

To receive a DoorLock/ClearRFIDCodeResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/ClearRFIDCodeResponse'

\subsection door_lock_clear_all_rfid_codes_cmd DoorLock/ClearAllRFIDCodes Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/ClearAllRFIDCodes
[PREFIX]/DoorLock/GeneratedCommands/ClearAllRFIDCodes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ClearAllRFIDCodes Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/ClearAllRFIDCodes command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/ClearAllRFIDCodes' -m  '{  }'

To receive a DoorLock/ClearAllRFIDCodes generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/ClearAllRFIDCodes'

\subsection door_lock_clear_all_rfid_codes_response_cmd DoorLock/ClearAllRFIDCodesResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/ClearAllRFIDCodesResponse
[PREFIX]/DoorLock/GeneratedCommands/ClearAllRFIDCodesResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ClearAllRFIDCodesResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "DrlkPassFailStatus"
    }
  },
  "required": [
    "Status"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/ClearAllRFIDCodesResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/ClearAllRFIDCodesResponse' -m  '{ "Status": <STATUS_VALUE> }'

To receive a DoorLock/ClearAllRFIDCodesResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/ClearAllRFIDCodesResponse'

\subsection door_lock_set_user_cmd DoorLock/SetUser Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/SetUser
[PREFIX]/DoorLock/GeneratedCommands/SetUser

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster SetUser Command Properties",
  "type": "object",
  "properties": {
    "OperationType": {
      "type": "DataOperationTypeEnum"
    },
    "UserIndex": {
      "type": "integer"
    },
    "UserName": {
      "type": "string"
    },
    "UserUniqueID": {
      "type": "integer"
    },
    "UserStatus": {
      "type": "DrlkUserStatus"
    },
    "UserType": {
      "type": "DrlkUserType"
    },
    "CredentialRule": {
      "type": "CredentialRuleEnum"
    }
  },
  "required": [
    "OperationType",
    "UserIndex",
    "UserName",
    "UserUniqueID",
    "UserStatus",
    "UserType",
    "CredentialRule"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/SetUser command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/SetUser' -m  '{ "OperationType": <OPERATION_TYPE_VALUE>,"UserIndex": <USER_INDEX_VALUE>,"UserName": <USER_NAME_VALUE>,"UserUniqueID": <USER_UNIQUEID_VALUE>,"UserStatus": <USER_STATUS_VALUE>,"UserType": <USER_TYPE_VALUE>,"CredentialRule": <CREDENTIAL_RULE_VALUE> }'

To receive a DoorLock/SetUser generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/SetUser'

\subsection door_lock_get_user_cmd DoorLock/GetUser Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/GetUser
[PREFIX]/DoorLock/GeneratedCommands/GetUser

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster GetUser Command Properties",
  "type": "object",
  "properties": {
    "UserIndex": {
      "type": "integer"
    }
  },
  "required": [
    "UserIndex"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/GetUser command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/GetUser' -m  '{ "UserIndex": <USER_INDEX_VALUE> }'

To receive a DoorLock/GetUser generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/GetUser'

\subsection door_lock_get_user_response_cmd DoorLock/GetUserResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/GetUserResponse
[PREFIX]/DoorLock/GeneratedCommands/GetUserResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster GetUserResponse Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/GetUserResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/GetUserResponse' -m  '{  }'

To receive a DoorLock/GetUserResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/GetUserResponse'

\subsection door_lock_clear_user_cmd DoorLock/ClearUser Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/ClearUser
[PREFIX]/DoorLock/GeneratedCommands/ClearUser

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ClearUser Command Properties",
  "type": "object",
  "properties": {
    "UserIndex": {
      "type": "integer"
    }
  },
  "required": [
    "UserIndex"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/ClearUser command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/ClearUser' -m  '{ "UserIndex": <USER_INDEX_VALUE> }'

To receive a DoorLock/ClearUser generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/ClearUser'

\subsection door_lock_operating_event_notification_cmd DoorLock/OperatingEventNotification Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/OperatingEventNotification
[PREFIX]/DoorLock/GeneratedCommands/OperatingEventNotification

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster OperatingEventNotification Command Properties",
  "type": "object",
  "properties": {
    "OperationEventSource": {
      "type": "DrlkOperEventSource"
    },
    "OperationEventCode": {
      "type": "OperatingEventNotificationOperationEventCode"
    },
    "UserID": {
      "type": "integer"
    },
    "PIN": {
      "type": "string"
    },
    "LocalTime": {
      "type": "integer"
    },
    "Data": {
      "type": "string"
    }
  },
  "required": [
    "OperationEventSource",
    "OperationEventCode",
    "UserID",
    "PIN",
    "LocalTime",
    "Data"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/OperatingEventNotification command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/OperatingEventNotification' -m  '{ "OperationEventSource": <OPERATION_EVENT_SOURCE_VALUE>,"OperationEventCode": <OPERATION_EVENT_CODE_VALUE>,"UserID": <USERID_VALUE>,"PIN": <PIN_VALUE>,"LocalTime": <LOCAL_TIME_VALUE>,"Data": <DATA_VALUE> }'

To receive a DoorLock/OperatingEventNotification generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/OperatingEventNotification'

\subsection door_lock_programming_event_notification_cmd DoorLock/ProgrammingEventNotification Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/ProgrammingEventNotification
[PREFIX]/DoorLock/GeneratedCommands/ProgrammingEventNotification

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ProgrammingEventNotification Command Properties",
  "type": "object",
  "properties": {
    "ProgramEventSource": {
      "type": "ProgrammingEventNotificationProgramEventSource"
    },
    "ProgramEventCode": {
      "type": "ProgrammingEventNotificationProgramEventCode"
    },
    "UserID": {
      "type": "integer"
    },
    "PIN": {
      "type": "string"
    },
    "UserType": {
      "type": "DrlkUserType"
    },
    "UserStatus": {
      "type": "DrlkUserStatus"
    },
    "LocalTime": {
      "type": "integer"
    },
    "Data": {
      "type": "string"
    }
  },
  "required": [
    "ProgramEventSource",
    "ProgramEventCode",
    "UserID",
    "PIN",
    "UserType",
    "UserStatus",
    "LocalTime",
    "Data"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/ProgrammingEventNotification command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/ProgrammingEventNotification' -m  '{ "ProgramEventSource": <PROGRAM_EVENT_SOURCE_VALUE>,"ProgramEventCode": <PROGRAM_EVENT_CODE_VALUE>,"UserID": <USERID_VALUE>,"PIN": <PIN_VALUE>,"UserType": <USER_TYPE_VALUE>,"UserStatus": <USER_STATUS_VALUE>,"LocalTime": <LOCAL_TIME_VALUE>,"Data": <DATA_VALUE> }'

To receive a DoorLock/ProgrammingEventNotification generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/ProgrammingEventNotification'

\subsection door_lock_set_credential_cmd DoorLock/SetCredential Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/SetCredential
[PREFIX]/DoorLock/GeneratedCommands/SetCredential

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster SetCredential Command Properties",
  "type": "object",
  "properties": {
    "OperationType": {
      "type": "DataOperationTypeEnum"
    },
    "Credential": {
      "type": "CredentialStruct"
    },
    "CredentialData": {
      "type": "string"
    },
    "UserIndex": {
      "type": "integer"
    },
    "UserStatus": {
      "type": "DrlkUserStatus"
    },
    "UserType": {
      "type": "DrlkUserType"
    }
  },
  "required": [
    "OperationType",
    "Credential",
    "CredentialData",
    "UserIndex",
    "UserStatus",
    "UserType"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/SetCredential command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/SetCredential' -m  '{ "OperationType": <OPERATION_TYPE_VALUE>,"Credential": <CREDENTIAL_VALUE>,"CredentialData": <CREDENTIAL_DATA_VALUE>,"UserIndex": <USER_INDEX_VALUE>,"UserStatus": <USER_STATUS_VALUE>,"UserType": <USER_TYPE_VALUE> }'

To receive a DoorLock/SetCredential generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/SetCredential'

\subsection door_lock_set_credential_response_cmd DoorLock/SetCredentialResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/SetCredentialResponse
[PREFIX]/DoorLock/GeneratedCommands/SetCredentialResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster SetCredentialResponse Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/SetCredentialResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/SetCredentialResponse' -m  '{  }'

To receive a DoorLock/SetCredentialResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/SetCredentialResponse'

\subsection door_lock_get_credential_status_cmd DoorLock/GetCredentialStatus Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/GetCredentialStatus
[PREFIX]/DoorLock/GeneratedCommands/GetCredentialStatus

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster GetCredentialStatus Command Properties",
  "type": "object",
  "properties": {
    "Credential": {
      "type": "CredentialStruct"
    }
  },
  "required": [
    "Credential"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/GetCredentialStatus command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/GetCredentialStatus' -m  '{ "Credential": <CREDENTIAL_VALUE> }'

To receive a DoorLock/GetCredentialStatus generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/GetCredentialStatus'

\subsection door_lock_get_credential_status_response_cmd DoorLock/GetCredentialStatusResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/GetCredentialStatusResponse
[PREFIX]/DoorLock/GeneratedCommands/GetCredentialStatusResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster GetCredentialStatusResponse Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/GetCredentialStatusResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/GetCredentialStatusResponse' -m  '{  }'

To receive a DoorLock/GetCredentialStatusResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/GetCredentialStatusResponse'

\subsection door_lock_clear_credential_cmd DoorLock/ClearCredential Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/ClearCredential
[PREFIX]/DoorLock/GeneratedCommands/ClearCredential

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ClearCredential Command Properties",
  "type": "object",
  "properties": {
    "Credential": {
      "type": "CredentialStruct"
    }
  },
  "required": [
    "Credential"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/ClearCredential command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/ClearCredential' -m  '{ "Credential": <CREDENTIAL_VALUE> }'

To receive a DoorLock/ClearCredential generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/ClearCredential'

\subsection door_lock_unbolt_door_cmd DoorLock/UnboltDoor Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/UnboltDoor
[PREFIX]/DoorLock/GeneratedCommands/UnboltDoor

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster UnboltDoor Command Properties",
  "type": "object",
  "properties": {
    "PINCode": {
      "type": "string"
    }
  },
  "required": [
    "PINCode"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/UnboltDoor command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/UnboltDoor' -m  '{ "PINCode": <PIN_CODE_VALUE> }'

To receive a DoorLock/UnboltDoor generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/UnboltDoor'

\subsection door_lock_write_attr_cmd DoorLock/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
    "DoorOpenEvents": {
      "type": "integer"
    },
    "DoorClosedEvents": {
      "type": "integer"
    },
    "OpenPeriod": {
      "type": "integer"
    },
    "EnableLogging": {
      "type": "boolean"
    },
    "Language": {
      "type": "string"
    },
    "LEDSettings": {
      "type": "integer"
    },
    "AutoRelockTime": {
      "type": "integer"
    },
    "SoundVolume": {
      "type": "integer"
    },
    "OperatingMode": {
      "type": "DrlkOperMode"
    },
    "EnableLocalProgramming": {
      "type": "boolean"
    },
    "EnableOneTouchLocking": {
      "type": "boolean"
    },
    "EnableInsideStatusLED": {
      "type": "boolean"
    },
    "EnablePrivacyModeButton": {
      "type": "boolean"
    },
    "LocalProgrammingFeatures": {
      "type": "DoorLockLocalProgrammingFeatures"
    },
    "WrongCodeEntryLimit": {
      "type": "integer"
    },
    "UserCodeTemporaryDisableTime": {
      "type": "integer"
    },
    "SendPINOverTheAir": {
      "type": "boolean"
    },
    "RequirePINforRFOperation": {
      "type": "boolean"
    },
    "ExpiringUserTimeout": {
      "type": "integer"
    },
    "AlarmMask": {
      "type": "DoorLockAlarmMask"
    },
    "KeypadOperationEventMask": {
      "type": "DoorLockKeypadOperationEventMask"
    },
    "RFOperationEventMask": {
      "type": "DoorLockRFOperationEventMask"
    },
    "ManualOperationEventMask": {
      "type": "DoorLockManualOperationEventMask"
    },
    "RFIDOperationEventMask": {
      "type": "DoorLockRFIDOperationEventMask"
    },
    "KeypadProgrammingEventMask": {
      "type": "DoorLockKeypadProgrammingEventMask"
    },
    "RFProgrammingEventMask": {
      "type": "DoorLockRFProgrammingEventMask"
    },
    "RFIDProgrammingEventMask": {
      "type": "DoorLockRFIDProgrammingEventMask"
    },
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all DoorLock attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/WriteAttributes' -m  '{ "DoorOpenEvents": <DOOR_OPEN_EVENTS_VALUE> ,"DoorClosedEvents": <DOOR_CLOSED_EVENTS_VALUE> ,"OpenPeriod": <OPEN_PERIOD_VALUE> ,"EnableLogging": <ENABLE_LOGGING_VALUE> ,"Language": <LANGUAGE_VALUE> ,"LEDSettings": <LED_SETTINGS_VALUE> ,"AutoRelockTime": <AUTO_RELOCK_TIME_VALUE> ,"SoundVolume": <SOUND_VOLUME_VALUE> ,"OperatingMode": <OPERATING_MODE_VALUE> ,"EnableLocalProgramming": <ENABLE_LOCAL_PROGRAMMING_VALUE> ,"EnableOneTouchLocking": <ENABLE_ONE_TOUCH_LOCKING_VALUE> ,"EnableInsideStatusLED": <ENABLE_INSIDE_STATUSLED_VALUE> ,"EnablePrivacyModeButton": <ENABLE_PRIVACY_MODE_BUTTON_VALUE> ,"LocalProgrammingFeatures": <LOCAL_PROGRAMMING_FEATURES_VALUE> ,"WrongCodeEntryLimit": <WRONG_CODE_ENTRY_LIMIT_VALUE> ,"UserCodeTemporaryDisableTime": <USER_CODE_TEMPORARY_DISABLE_TIME_VALUE> ,"SendPINOverTheAir": <SEND_PIN_OVER_THE_AIR_VALUE> ,"RequirePINforRFOperation": <REQUIRE_PI_NFOR_RF_OPERATION_VALUE> ,"ExpiringUserTimeout": <EXPIRING_USER_TIMEOUT_VALUE> ,"AlarmMask": <ALARM_MASK_VALUE> ,"KeypadOperationEventMask": <KEYPAD_OPERATION_EVENT_MASK_VALUE> ,"RFOperationEventMask": <RF_OPERATION_EVENT_MASK_VALUE> ,"ManualOperationEventMask": <MANUAL_OPERATION_EVENT_MASK_VALUE> ,"RFIDOperationEventMask": <RFID_OPERATION_EVENT_MASK_VALUE> ,"KeypadProgrammingEventMask": <KEYPAD_PROGRAMMING_EVENT_MASK_VALUE> ,"RFProgrammingEventMask": <RF_PROGRAMMING_EVENT_MASK_VALUE> ,"RFIDProgrammingEventMask": <RFID_PROGRAMMING_EVENT_MASK_VALUE> , }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection door_lock_force_read_attr_cmd DoorLock/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "LockState",
          "LockType",
          "ActuatorEnabled",
          "DoorState",
          "DoorOpenEvents",
          "DoorClosedEvents",
          "OpenPeriod",
          "NumberOfLogRecordsSupported",
          "NumberOfTotalUsersSupported",
          "NumberOfPINUsersSupported",
          "NumberOfRFIDUsersSupported",
          "NumberOfWeekDaySchedulesSupportedPerUser",
          "NumberOfYearDaySchedulesSupportedPerUser",
          "NumberOfHolidaySchedulesSupported",
          "MaxPINCodeLength",
          "MinPINCodeLength",
          "MaxRFIDCodeLength",
          "MinRFIDCodeLength",
          "CredentialRulesSupport",
          "NumberOfCredentialsSupportedPerUser",
          "EnableLogging",
          "Language",
          "LEDSettings",
          "AutoRelockTime",
          "SoundVolume",
          "OperatingMode",
          "SupportedOperatingModes",
          "DefaultConfigurationRegister",
          "EnableLocalProgramming",
          "EnableOneTouchLocking",
          "EnableInsideStatusLED",
          "EnablePrivacyModeButton",
          "LocalProgrammingFeatures",
          "WrongCodeEntryLimit",
          "UserCodeTemporaryDisableTime",
          "SendPINOverTheAir",
          "RequirePINforRFOperation",
          "SecurityLevel",
          "ExpiringUserTimeout",
          "AlarmMask",
          "KeypadOperationEventMask",
          "RFOperationEventMask",
          "ManualOperationEventMask",
          "RFIDOperationEventMask",
          "KeypadProgrammingEventMask",
          "RFProgrammingEventMask",
          "RFIDProgrammingEventMask",
          "FeatureMap"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all DoorLock attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the DoorLock attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/ForceReadAttributes' -m  '{ "value": ["LockState"] }'

\page window_covering WindowCovering Cluster The following commands and attributes are accepted as JSON payloads for the WindowCovering cluster.

\section window_covering_attrs WindowCovering Attributes The following attribute topics are used to retrieve the WindowCovering cluster state.

\subsection window_covering_attr_window_covering_type WindowCovering/WindowCoveringType Attribute

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Attributes/WindowCoveringType/Reported
[PREFIX]/WindowCovering/Attributes/WindowCoveringType/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindowCovering Cluster WindowCoveringType Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "WindowCoveringWindowCoveringType"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for WindowCoveringType attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/WindowCovering/Attributes/WindowCoveringType/+'

# Example output

ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/WindowCoveringType/Desired { "value": <DESIRED_WINDOW_COVERING_TYPE>}
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/WindowCoveringType/Reported { "value": <REPORTED_WINDOW_COVERING_TYPE>}

\subsection window_covering_attr_physical_closed_limit_lift WindowCovering/PhysicalClosedLimitLift Attribute

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Attributes/PhysicalClosedLimitLift/Reported
[PREFIX]/WindowCovering/Attributes/PhysicalClosedLimitLift/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindowCovering Cluster PhysicalClosedLimitLift Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for PhysicalClosedLimitLift attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/WindowCovering/Attributes/PhysicalClosedLimitLift/+'

# Example output

ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/PhysicalClosedLimitLift/Desired { "value": <DESIRED_PHYSICAL_CLOSED_LIMIT_LIFT>}
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/PhysicalClosedLimitLift/Reported { "value": <REPORTED_PHYSICAL_CLOSED_LIMIT_LIFT>}

\subsection window_covering_attr_physical_closed_limit_tilt WindowCovering/PhysicalClosedLimitTilt Attribute

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Attributes/PhysicalClosedLimitTilt/Reported
[PREFIX]/WindowCovering/Attributes/PhysicalClosedLimitTilt/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindowCovering Cluster PhysicalClosedLimitTilt Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for PhysicalClosedLimitTilt attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/WindowCovering/Attributes/PhysicalClosedLimitTilt/+'

# Example output

ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/PhysicalClosedLimitTilt/Desired { "value": <DESIRED_PHYSICAL_CLOSED_LIMIT_TILT>}
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/PhysicalClosedLimitTilt/Reported { "value": <REPORTED_PHYSICAL_CLOSED_LIMIT_TILT>}

\subsection window_covering_attr_current_position_lift WindowCovering/CurrentPositionLift Attribute

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Attributes/CurrentPositionLift/Reported
[PREFIX]/WindowCovering/Attributes/CurrentPositionLift/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindowCovering Cluster CurrentPositionLift Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CurrentPositionLift attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/WindowCovering/Attributes/CurrentPositionLift/+'

# Example output

ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/CurrentPositionLift/Desired { "value": <DESIRED_CURRENT_POSITION_LIFT>}
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/CurrentPositionLift/Reported { "value": <REPORTED_CURRENT_POSITION_LIFT>}

\subsection window_covering_attr_current_position_tilt WindowCovering/CurrentPositionTilt Attribute

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Attributes/CurrentPositionTilt/Reported
[PREFIX]/WindowCovering/Attributes/CurrentPositionTilt/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindowCovering Cluster CurrentPositionTilt Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CurrentPositionTilt attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/WindowCovering/Attributes/CurrentPositionTilt/+'

# Example output

ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/CurrentPositionTilt/Desired { "value": <DESIRED_CURRENT_POSITION_TILT>}
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/CurrentPositionTilt/Reported { "value": <REPORTED_CURRENT_POSITION_TILT>}

\subsection window_covering_attr_number_of_actuations_lift WindowCovering/NumberOfActuationsLift Attribute

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Attributes/NumberOfActuationsLift/Reported
[PREFIX]/WindowCovering/Attributes/NumberOfActuationsLift/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindowCovering Cluster NumberOfActuationsLift Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for NumberOfActuationsLift attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/WindowCovering/Attributes/NumberOfActuationsLift/+'

# Example output

ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/NumberOfActuationsLift/Desired { "value": <DESIRED_NUMBER_OF_ACTUATIONS_LIFT>}
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/NumberOfActuationsLift/Reported { "value": <REPORTED_NUMBER_OF_ACTUATIONS_LIFT>}

\subsection window_covering_attr_number_of_actuations_tilt WindowCovering/NumberOfActuationsTilt Attribute

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Attributes/NumberOfActuationsTilt/Reported
[PREFIX]/WindowCovering/Attributes/NumberOfActuationsTilt/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindowCovering Cluster NumberOfActuationsTilt Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for NumberOfActuationsTilt attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/WindowCovering/Attributes/NumberOfActuationsTilt/+'

# Example output

ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/NumberOfActuationsTilt/Desired { "value": <DESIRED_NUMBER_OF_ACTUATIONS_TILT>}
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/NumberOfActuationsTilt/Reported { "value": <REPORTED_NUMBER_OF_ACTUATIONS_TILT>}

\subsection window_covering_attr_config_or_status WindowCovering/ConfigOrStatus Attribute

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Attributes/ConfigOrStatus/Reported
[PREFIX]/WindowCovering/Attributes/ConfigOrStatus/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindowCovering Cluster ConfigOrStatus Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "WindowCoveringConfigOrStatus"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ConfigOrStatus attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/WindowCovering/Attributes/ConfigOrStatus/+'

# Example output

ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/ConfigOrStatus/Desired { "value": <DESIRED_CONFIG_OR_STATUS>}
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/ConfigOrStatus/Reported { "value": <REPORTED_CONFIG_OR_STATUS>}

\subsection window_covering_attr_current_position_lift_percentage WindowCovering/CurrentPositionLiftPercentage Attribute

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Attributes/CurrentPositionLiftPercentage/Reported
[PREFIX]/WindowCovering/Attributes/CurrentPositionLiftPercentage/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindowCovering Cluster CurrentPositionLiftPercentage Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CurrentPositionLiftPercentage attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/WindowCovering/Attributes/CurrentPositionLiftPercentage/+'

# Example output

ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/CurrentPositionLiftPercentage/Desired { "value": <DESIRED_CURRENT_POSITION_LIFT_PERCENTAGE>}
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/CurrentPositionLiftPercentage/Reported { "value": <REPORTED_CURRENT_POSITION_LIFT_PERCENTAGE>}

\subsection window_covering_attr_current_position_tilt_percentage WindowCovering/CurrentPositionTiltPercentage Attribute

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Attributes/CurrentPositionTiltPercentage/Reported
[PREFIX]/WindowCovering/Attributes/CurrentPositionTiltPercentage/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindowCovering Cluster CurrentPositionTiltPercentage Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CurrentPositionTiltPercentage attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/WindowCovering/Attributes/CurrentPositionTiltPercentage/+'

# Example output

ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/CurrentPositionTiltPercentage/Desired { "value": <DESIRED_CURRENT_POSITION_TILT_PERCENTAGE>}
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/CurrentPositionTiltPercentage/Reported { "value": <REPORTED_CURRENT_POSITION_TILT_PERCENTAGE>}

\subsection window_covering_attr_installed_open_limit_lift WindowCovering/InstalledOpenLimitLift Attribute

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Attributes/InstalledOpenLimitLift/Reported
[PREFIX]/WindowCovering/Attributes/InstalledOpenLimitLift/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindowCovering Cluster InstalledOpenLimitLift Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for InstalledOpenLimitLift attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/WindowCovering/Attributes/InstalledOpenLimitLift/+'

# Example output

ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/InstalledOpenLimitLift/Desired { "value": <DESIRED_INSTALLED_OPEN_LIMIT_LIFT>}
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/InstalledOpenLimitLift/Reported { "value": <REPORTED_INSTALLED_OPEN_LIMIT_LIFT>}

\subsection window_covering_attr_installed_closed_limit_lift WindowCovering/InstalledClosedLimitLift Attribute

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Attributes/InstalledClosedLimitLift/Reported
[PREFIX]/WindowCovering/Attributes/InstalledClosedLimitLift/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindowCovering Cluster InstalledClosedLimitLift Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for InstalledClosedLimitLift attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/WindowCovering/Attributes/InstalledClosedLimitLift/+'

# Example output

ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/InstalledClosedLimitLift/Desired { "value": <DESIRED_INSTALLED_CLOSED_LIMIT_LIFT>}
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/InstalledClosedLimitLift/Reported { "value": <REPORTED_INSTALLED_CLOSED_LIMIT_LIFT>}

\subsection window_covering_attr_installed_open_limit_tilt WindowCovering/InstalledOpenLimitTilt Attribute

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Attributes/InstalledOpenLimitTilt/Reported
[PREFIX]/WindowCovering/Attributes/InstalledOpenLimitTilt/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindowCovering Cluster InstalledOpenLimitTilt Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for InstalledOpenLimitTilt attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/WindowCovering/Attributes/InstalledOpenLimitTilt/+'

# Example output

ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/InstalledOpenLimitTilt/Desired { "value": <DESIRED_INSTALLED_OPEN_LIMIT_TILT>}
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/InstalledOpenLimitTilt/Reported { "value": <REPORTED_INSTALLED_OPEN_LIMIT_TILT>}

\subsection window_covering_attr_installed_closed_limit_tilt WindowCovering/InstalledClosedLimitTilt Attribute

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Attributes/InstalledClosedLimitTilt/Reported
[PREFIX]/WindowCovering/Attributes/InstalledClosedLimitTilt/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindowCovering Cluster InstalledClosedLimitTilt Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for InstalledClosedLimitTilt attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/WindowCovering/Attributes/InstalledClosedLimitTilt/+'

# Example output

ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/InstalledClosedLimitTilt/Desired { "value": <DESIRED_INSTALLED_CLOSED_LIMIT_TILT>}
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/InstalledClosedLimitTilt/Reported { "value": <REPORTED_INSTALLED_CLOSED_LIMIT_TILT>}

\subsection window_covering_attr_velocity_lift WindowCovering/VelocityLift Attribute

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Attributes/VelocityLift/Reported
[PREFIX]/WindowCovering/Attributes/VelocityLift/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindowCovering Cluster VelocityLift Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for VelocityLift attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/WindowCovering/Attributes/VelocityLift/+'

# Example output

ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/VelocityLift/Desired { "value": <DESIRED_VELOCITY_LIFT>}
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/VelocityLift/Reported { "value": <REPORTED_VELOCITY_LIFT>}

\subsection window_covering_attr_acceleration_time_lift WindowCovering/AccelerationTimeLift Attribute

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Attributes/AccelerationTimeLift/Reported
[PREFIX]/WindowCovering/Attributes/AccelerationTimeLift/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindowCovering Cluster AccelerationTimeLift Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for AccelerationTimeLift attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/WindowCovering/Attributes/AccelerationTimeLift/+'

# Example output

ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/AccelerationTimeLift/Desired { "value": <DESIRED_ACCELERATION_TIME_LIFT>}
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/AccelerationTimeLift/Reported { "value": <REPORTED_ACCELERATION_TIME_LIFT>}

\subsection window_covering_attr_deceleration_time_lift WindowCovering/DecelerationTimeLift Attribute

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Attributes/DecelerationTimeLift/Reported
[PREFIX]/WindowCovering/Attributes/DecelerationTimeLift/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindowCovering Cluster DecelerationTimeLift Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DecelerationTimeLift attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/WindowCovering/Attributes/DecelerationTimeLift/+'

# Example output

ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/DecelerationTimeLift/Desired { "value": <DESIRED_DECELERATION_TIME_LIFT>}
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/DecelerationTimeLift/Reported { "value": <REPORTED_DECELERATION_TIME_LIFT>}

\subsection window_covering_attr_mode WindowCovering/Mode Attribute

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Attributes/Mode/Reported
[PREFIX]/WindowCovering/Attributes/Mode/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindowCovering Cluster Mode Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "WindowCoveringMode"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Mode attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/WindowCovering/Attributes/Mode/+'

# Example output

ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/Mode/Desired { "value": <DESIRED_MODE>}
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/Mode/Reported { "value": <REPORTED_MODE>}

\subsection window_covering_attr_intermediate_setpoints_lift WindowCovering/IntermediateSetpointsLift Attribute

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Attributes/IntermediateSetpointsLift/Reported
[PREFIX]/WindowCovering/Attributes/IntermediateSetpointsLift/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindowCovering Cluster IntermediateSetpointsLift Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for IntermediateSetpointsLift attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/WindowCovering/Attributes/IntermediateSetpointsLift/+'

# Example output

ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/IntermediateSetpointsLift/Desired { "value": <DESIRED_INTERMEDIATE_SETPOINTS_LIFT>}
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/IntermediateSetpointsLift/Reported { "value": <REPORTED_INTERMEDIATE_SETPOINTS_LIFT>}

\subsection window_covering_attr_intermediate_setpoints_tilt WindowCovering/IntermediateSetpointsTilt Attribute

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Attributes/IntermediateSetpointsTilt/Reported
[PREFIX]/WindowCovering/Attributes/IntermediateSetpointsTilt/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindowCovering Cluster IntermediateSetpointsTilt Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for IntermediateSetpointsTilt attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/WindowCovering/Attributes/IntermediateSetpointsTilt/+'

# Example output

ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/IntermediateSetpointsTilt/Desired { "value": <DESIRED_INTERMEDIATE_SETPOINTS_TILT>}
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/IntermediateSetpointsTilt/Reported { "value": <REPORTED_INTERMEDIATE_SETPOINTS_TILT>}

\subsection window_covering_attr_cluster_revision WindowCovering/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Attributes/ClusterRevision/Reported
[PREFIX]/WindowCovering/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindowCovering Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/WindowCovering/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/WindowCovering/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/WindowCovering/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section window_covering_recv_cmd_support WindowCovering Command Support

MQTT Topic Pattern:

[PREFIX]/WindowCovering/SupportedCommands
[PREFIX]/WindowCovering/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindowCovering Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
              "UpOrOpen",
              "DownOrClose",
              "Stop",
              "GoToLiftValue",
              "GoToLiftPercentage",
              "GoToTiltValue",
              "GoToTiltPercentage",
              "WriteAttributes",
              "ForceReadAttributes"
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for WindowCovering cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/WindowCovering/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/WindowCovering/SupportedCommands { "value": ["UpOrOpen","DownOrClose","Stop","GoToLiftValue","GoToLiftPercentage","GoToTiltValue","GoToTiltPercentage","WriteAttributes", "ForceReadAttributes"] }

To see supported generated commands for WindowCovering cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/WindowCovering/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/WindowCovering/SupportedGeneratedCommands { "value": [] }

\section window_covering_cmds WindowCovering Commands

\subsection window_covering_up_or_open_cmd WindowCovering/UpOrOpen Command

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Commands/UpOrOpen
[PREFIX]/WindowCovering/GeneratedCommands/UpOrOpen

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindowCovering Cluster UpOrOpen Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
  ]
}

Example Mosquitto CLI Tool Usage

To send a WindowCovering/UpOrOpen command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/WindowCovering/Commands/UpOrOpen' -m  '{  }'

To receive a WindowCovering/UpOrOpen generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/WindowCovering/GeneratedCommands/UpOrOpen'

\subsection window_covering_down_or_close_cmd WindowCovering/DownOrClose Command

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Commands/DownOrClose
[PREFIX]/WindowCovering/GeneratedCommands/DownOrClose

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindowCovering Cluster DownOrClose Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
  ]
}

Example Mosquitto CLI Tool Usage

To send a WindowCovering/DownOrClose command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/WindowCovering/Commands/DownOrClose' -m  '{  }'

To receive a WindowCovering/DownOrClose generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/WindowCovering/GeneratedCommands/DownOrClose'

\subsection window_covering_stop_cmd WindowCovering/Stop Command

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Commands/Stop
[PREFIX]/WindowCovering/GeneratedCommands/Stop

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindowCovering Cluster Stop Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
  ]
}

Example Mosquitto CLI Tool Usage

To send a WindowCovering/Stop command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/WindowCovering/Commands/Stop' -m  '{  }'

To receive a WindowCovering/Stop generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/WindowCovering/GeneratedCommands/Stop'

\subsection window_covering_go_to_lift_value_cmd WindowCovering/GoToLiftValue Command

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Commands/GoToLiftValue
[PREFIX]/WindowCovering/GeneratedCommands/GoToLiftValue

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindowCovering Cluster GoToLiftValue Command Properties",
  "type": "object",
  "properties": {
    "LiftValue": {
      "type": "integer"
    }
  },
  "required": [
    "LiftValue"
  ]
}

Example Mosquitto CLI Tool Usage

To send a WindowCovering/GoToLiftValue command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/WindowCovering/Commands/GoToLiftValue' -m  '{ "LiftValue": <LIFT_VALUE_VALUE> }'

To receive a WindowCovering/GoToLiftValue generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/WindowCovering/GeneratedCommands/GoToLiftValue'

\subsection window_covering_go_to_lift_percentage_cmd WindowCovering/GoToLiftPercentage Command

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Commands/GoToLiftPercentage
[PREFIX]/WindowCovering/GeneratedCommands/GoToLiftPercentage

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindowCovering Cluster GoToLiftPercentage Command Properties",
  "type": "object",
  "properties": {
    "PercentageLiftValue": {
      "type": "integer"
    }
  },
  "required": [
    "PercentageLiftValue"
  ]
}

Example Mosquitto CLI Tool Usage

To send a WindowCovering/GoToLiftPercentage command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/WindowCovering/Commands/GoToLiftPercentage' -m  '{ "PercentageLiftValue": <PERCENTAGE_LIFT_VALUE_VALUE> }'

To receive a WindowCovering/GoToLiftPercentage generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/WindowCovering/GeneratedCommands/GoToLiftPercentage'

\subsection window_covering_go_to_tilt_value_cmd WindowCovering/GoToTiltValue Command

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Commands/GoToTiltValue
[PREFIX]/WindowCovering/GeneratedCommands/GoToTiltValue

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindowCovering Cluster GoToTiltValue Command Properties",
  "type": "object",
  "properties": {
    "TiltValue": {
      "type": "integer"
    }
  },
  "required": [
    "TiltValue"
  ]
}

Example Mosquitto CLI Tool Usage

To send a WindowCovering/GoToTiltValue command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/WindowCovering/Commands/GoToTiltValue' -m  '{ "TiltValue": <TILT_VALUE_VALUE> }'

To receive a WindowCovering/GoToTiltValue generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/WindowCovering/GeneratedCommands/GoToTiltValue'

\subsection window_covering_go_to_tilt_percentage_cmd WindowCovering/GoToTiltPercentage Command

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Commands/GoToTiltPercentage
[PREFIX]/WindowCovering/GeneratedCommands/GoToTiltPercentage

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindowCovering Cluster GoToTiltPercentage Command Properties",
  "type": "object",
  "properties": {
    "PercentageTiltValue": {
      "type": "integer"
    }
  },
  "required": [
    "PercentageTiltValue"
  ]
}

Example Mosquitto CLI Tool Usage

To send a WindowCovering/GoToTiltPercentage command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/WindowCovering/Commands/GoToTiltPercentage' -m  '{ "PercentageTiltValue": <PERCENTAGE_TILT_VALUE_VALUE> }'

To receive a WindowCovering/GoToTiltPercentage generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/WindowCovering/GeneratedCommands/GoToTiltPercentage'

\subsection window_covering_write_attr_cmd WindowCovering/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindowCovering Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
    "VelocityLift": {
      "type": "integer"
    },
    "AccelerationTimeLift": {
      "type": "integer"
    },
    "DecelerationTimeLift": {
      "type": "integer"
    },
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all WindowCovering attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/WindowCovering/Commands/WriteAttributes' -m  '{ "VelocityLift": <VELOCITY_LIFT_VALUE> ,"AccelerationTimeLift": <ACCELERATION_TIME_LIFT_VALUE> ,"DecelerationTimeLift": <DECELERATION_TIME_LIFT_VALUE> , }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection window_covering_force_read_attr_cmd WindowCovering/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindowCovering Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "WindowCoveringType",
          "PhysicalClosedLimitLift",
          "PhysicalClosedLimitTilt",
          "CurrentPositionLift",
          "CurrentPositionTilt",
          "NumberOfActuationsLift",
          "NumberOfActuationsTilt",
          "ConfigOrStatus",
          "CurrentPositionLiftPercentage",
          "CurrentPositionTiltPercentage",
          "InstalledOpenLimitLift",
          "InstalledClosedLimitLift",
          "InstalledOpenLimitTilt",
          "InstalledClosedLimitTilt",
          "VelocityLift",
          "AccelerationTimeLift",
          "DecelerationTimeLift",
          "Mode",
          "IntermediateSetpointsLift",
          "IntermediateSetpointsTilt"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all WindowCovering attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/WindowCovering/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the WindowCovering attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/WindowCovering/Commands/ForceReadAttributes' -m  '{ "value": ["WindowCoveringType"] }'

\page barrier_control BarrierControl Cluster The following commands and attributes are accepted as JSON payloads for the BarrierControl cluster.

\section barrier_control_attrs BarrierControl Attributes The following attribute topics are used to retrieve the BarrierControl cluster state.

\subsection barrier_control_attr_moving_state BarrierControl/MovingState Attribute

MQTT Topic Pattern:

[PREFIX]/BarrierControl/Attributes/MovingState/Reported
[PREFIX]/BarrierControl/Attributes/MovingState/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BarrierControl Cluster MovingState Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "BarrierControlMovingState"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MovingState attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/BarrierControl/Attributes/MovingState/+'

# Example output

ucl/by-unid/<UNID>/ep0/BarrierControl/Attributes/MovingState/Desired { "value": <DESIRED_MOVING_STATE>}
ucl/by-unid/<UNID>/ep0/BarrierControl/Attributes/MovingState/Reported { "value": <REPORTED_MOVING_STATE>}

\subsection barrier_control_attr_safety_status BarrierControl/SafetyStatus Attribute

MQTT Topic Pattern:

[PREFIX]/BarrierControl/Attributes/SafetyStatus/Reported
[PREFIX]/BarrierControl/Attributes/SafetyStatus/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BarrierControl Cluster SafetyStatus Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "BarrierControlSafetyStatus"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for SafetyStatus attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/BarrierControl/Attributes/SafetyStatus/+'

# Example output

ucl/by-unid/<UNID>/ep0/BarrierControl/Attributes/SafetyStatus/Desired { "value": <DESIRED_SAFETY_STATUS>}
ucl/by-unid/<UNID>/ep0/BarrierControl/Attributes/SafetyStatus/Reported { "value": <REPORTED_SAFETY_STATUS>}

\subsection barrier_control_attr_capabilities BarrierControl/Capabilities Attribute

MQTT Topic Pattern:

[PREFIX]/BarrierControl/Attributes/Capabilities/Reported
[PREFIX]/BarrierControl/Attributes/Capabilities/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BarrierControl Cluster Capabilities Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "BarrierControlCapabilities"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Capabilities attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/BarrierControl/Attributes/Capabilities/+'

# Example output

ucl/by-unid/<UNID>/ep0/BarrierControl/Attributes/Capabilities/Desired { "value": <DESIRED_CAPABILITIES>}
ucl/by-unid/<UNID>/ep0/BarrierControl/Attributes/Capabilities/Reported { "value": <REPORTED_CAPABILITIES>}

\subsection barrier_control_attr_open_events BarrierControl/OpenEvents Attribute

MQTT Topic Pattern:

[PREFIX]/BarrierControl/Attributes/OpenEvents/Reported
[PREFIX]/BarrierControl/Attributes/OpenEvents/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BarrierControl Cluster OpenEvents Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for OpenEvents attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/BarrierControl/Attributes/OpenEvents/+'

# Example output

ucl/by-unid/<UNID>/ep0/BarrierControl/Attributes/OpenEvents/Desired { "value": <DESIRED_OPEN_EVENTS>}
ucl/by-unid/<UNID>/ep0/BarrierControl/Attributes/OpenEvents/Reported { "value": <REPORTED_OPEN_EVENTS>}

\subsection barrier_control_attr_close_events BarrierControl/CloseEvents Attribute

MQTT Topic Pattern:

[PREFIX]/BarrierControl/Attributes/CloseEvents/Reported
[PREFIX]/BarrierControl/Attributes/CloseEvents/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BarrierControl Cluster CloseEvents Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CloseEvents attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/BarrierControl/Attributes/CloseEvents/+'

# Example output

ucl/by-unid/<UNID>/ep0/BarrierControl/Attributes/CloseEvents/Desired { "value": <DESIRED_CLOSE_EVENTS>}
ucl/by-unid/<UNID>/ep0/BarrierControl/Attributes/CloseEvents/Reported { "value": <REPORTED_CLOSE_EVENTS>}

\subsection barrier_control_attr_command_open_events BarrierControl/CommandOpenEvents Attribute

MQTT Topic Pattern:

[PREFIX]/BarrierControl/Attributes/CommandOpenEvents/Reported
[PREFIX]/BarrierControl/Attributes/CommandOpenEvents/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BarrierControl Cluster CommandOpenEvents Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CommandOpenEvents attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/BarrierControl/Attributes/CommandOpenEvents/+'

# Example output

ucl/by-unid/<UNID>/ep0/BarrierControl/Attributes/CommandOpenEvents/Desired { "value": <DESIRED_COMMAND_OPEN_EVENTS>}
ucl/by-unid/<UNID>/ep0/BarrierControl/Attributes/CommandOpenEvents/Reported { "value": <REPORTED_COMMAND_OPEN_EVENTS>}

\subsection barrier_control_attr_command_close_events BarrierControl/CommandCloseEvents Attribute

MQTT Topic Pattern:

[PREFIX]/BarrierControl/Attributes/CommandCloseEvents/Reported
[PREFIX]/BarrierControl/Attributes/CommandCloseEvents/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BarrierControl Cluster CommandCloseEvents Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CommandCloseEvents attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/BarrierControl/Attributes/CommandCloseEvents/+'

# Example output

ucl/by-unid/<UNID>/ep0/BarrierControl/Attributes/CommandCloseEvents/Desired { "value": <DESIRED_COMMAND_CLOSE_EVENTS>}
ucl/by-unid/<UNID>/ep0/BarrierControl/Attributes/CommandCloseEvents/Reported { "value": <REPORTED_COMMAND_CLOSE_EVENTS>}

\subsection barrier_control_attr_open_period BarrierControl/OpenPeriod Attribute

MQTT Topic Pattern:

[PREFIX]/BarrierControl/Attributes/OpenPeriod/Reported
[PREFIX]/BarrierControl/Attributes/OpenPeriod/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BarrierControl Cluster OpenPeriod Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for OpenPeriod attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/BarrierControl/Attributes/OpenPeriod/+'

# Example output

ucl/by-unid/<UNID>/ep0/BarrierControl/Attributes/OpenPeriod/Desired { "value": <DESIRED_OPEN_PERIOD>}
ucl/by-unid/<UNID>/ep0/BarrierControl/Attributes/OpenPeriod/Reported { "value": <REPORTED_OPEN_PERIOD>}

\subsection barrier_control_attr_close_period BarrierControl/ClosePeriod Attribute

MQTT Topic Pattern:

[PREFIX]/BarrierControl/Attributes/ClosePeriod/Reported
[PREFIX]/BarrierControl/Attributes/ClosePeriod/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BarrierControl Cluster ClosePeriod Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClosePeriod attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/BarrierControl/Attributes/ClosePeriod/+'

# Example output

ucl/by-unid/<UNID>/ep0/BarrierControl/Attributes/ClosePeriod/Desired { "value": <DESIRED_CLOSE_PERIOD>}
ucl/by-unid/<UNID>/ep0/BarrierControl/Attributes/ClosePeriod/Reported { "value": <REPORTED_CLOSE_PERIOD>}

\subsection barrier_control_attr_barrier_position BarrierControl/BarrierPosition Attribute

MQTT Topic Pattern:

[PREFIX]/BarrierControl/Attributes/BarrierPosition/Reported
[PREFIX]/BarrierControl/Attributes/BarrierPosition/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BarrierControl Cluster BarrierPosition Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for BarrierPosition attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/BarrierControl/Attributes/BarrierPosition/+'

# Example output

ucl/by-unid/<UNID>/ep0/BarrierControl/Attributes/BarrierPosition/Desired { "value": <DESIRED_BARRIER_POSITION>}
ucl/by-unid/<UNID>/ep0/BarrierControl/Attributes/BarrierPosition/Reported { "value": <REPORTED_BARRIER_POSITION>}

\subsection barrier_control_attr_cluster_revision BarrierControl/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/BarrierControl/Attributes/ClusterRevision/Reported
[PREFIX]/BarrierControl/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BarrierControl Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/BarrierControl/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/BarrierControl/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/BarrierControl/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section barrier_control_recv_cmd_support BarrierControl Command Support

MQTT Topic Pattern:

[PREFIX]/BarrierControl/SupportedCommands
[PREFIX]/BarrierControl/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BarrierControl Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
              "GoToPercent",
              "Stop",
              "WriteAttributes",
              "ForceReadAttributes"
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for BarrierControl cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/BarrierControl/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/BarrierControl/SupportedCommands { "value": ["GoToPercent","Stop","WriteAttributes", "ForceReadAttributes"] }

To see supported generated commands for BarrierControl cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/BarrierControl/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/BarrierControl/SupportedGeneratedCommands { "value": [] }

\section barrier_control_cmds BarrierControl Commands

\subsection barrier_control_go_to_percent_cmd BarrierControl/GoToPercent Command

MQTT Topic Pattern:

[PREFIX]/BarrierControl/Commands/GoToPercent
[PREFIX]/BarrierControl/GeneratedCommands/GoToPercent

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BarrierControl Cluster GoToPercent Command Properties",
  "type": "object",
  "properties": {
    "PercentOpen": {
      "type": "integer"
    }
  },
  "required": [
    "PercentOpen"
  ]
}

Example Mosquitto CLI Tool Usage

To send a BarrierControl/GoToPercent command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/BarrierControl/Commands/GoToPercent' -m  '{ "PercentOpen": <PERCENT_OPEN_VALUE> }'

To receive a BarrierControl/GoToPercent generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/BarrierControl/GeneratedCommands/GoToPercent'

\subsection barrier_control_stop_cmd BarrierControl/Stop Command

MQTT Topic Pattern:

[PREFIX]/BarrierControl/Commands/Stop
[PREFIX]/BarrierControl/GeneratedCommands/Stop

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BarrierControl Cluster Stop Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
  ]
}

Example Mosquitto CLI Tool Usage

To send a BarrierControl/Stop command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/BarrierControl/Commands/Stop' -m  '{  }'

To receive a BarrierControl/Stop generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/BarrierControl/GeneratedCommands/Stop'

\subsection barrier_control_write_attr_cmd BarrierControl/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/BarrierControl/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BarrierControl Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
    "OpenEvents": {
      "type": "integer"
    },
    "CloseEvents": {
      "type": "integer"
    },
    "CommandOpenEvents": {
      "type": "integer"
    },
    "CommandCloseEvents": {
      "type": "integer"
    },
    "OpenPeriod": {
      "type": "integer"
    },
    "ClosePeriod": {
      "type": "integer"
    },
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all BarrierControl attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/BarrierControl/Commands/WriteAttributes' -m  '{ "OpenEvents": <OPEN_EVENTS_VALUE> ,"CloseEvents": <CLOSE_EVENTS_VALUE> ,"CommandOpenEvents": <COMMAND_OPEN_EVENTS_VALUE> ,"CommandCloseEvents": <COMMAND_CLOSE_EVENTS_VALUE> ,"OpenPeriod": <OPEN_PERIOD_VALUE> ,"ClosePeriod": <CLOSE_PERIOD_VALUE> , }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection barrier_control_force_read_attr_cmd BarrierControl/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/BarrierControl/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BarrierControl Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "MovingState",
          "SafetyStatus",
          "Capabilities",
          "OpenEvents",
          "CloseEvents",
          "CommandOpenEvents",
          "CommandCloseEvents",
          "OpenPeriod",
          "ClosePeriod",
          "BarrierPosition"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all BarrierControl attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/BarrierControl/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the BarrierControl attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/BarrierControl/Commands/ForceReadAttributes' -m  '{ "value": ["MovingState"] }'

\page pump_configuration_and_control PumpConfigurationAndControl Cluster The following commands and attributes are accepted as JSON payloads for the PumpConfigurationAndControl cluster.

\section pump_configuration_and_control_attrs PumpConfigurationAndControl Attributes The following attribute topics are used to retrieve the PumpConfigurationAndControl cluster state.

\subsection pump_configuration_and_control_attr_max_pressure PumpConfigurationAndControl/MaxPressure Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/MaxPressure/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/MaxPressure/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PumpConfigurationAndControl Cluster MaxPressure Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MaxPressure attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/MaxPressure/+'

# Example output

ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MaxPressure/Desired { "value": <DESIRED_MAX_PRESSURE>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MaxPressure/Reported { "value": <REPORTED_MAX_PRESSURE>}

\subsection pump_configuration_and_control_attr_max_speed PumpConfigurationAndControl/MaxSpeed Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/MaxSpeed/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/MaxSpeed/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PumpConfigurationAndControl Cluster MaxSpeed Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MaxSpeed attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/MaxSpeed/+'

# Example output

ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MaxSpeed/Desired { "value": <DESIRED_MAX_SPEED>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MaxSpeed/Reported { "value": <REPORTED_MAX_SPEED>}

\subsection pump_configuration_and_control_attr_max_flow PumpConfigurationAndControl/MaxFlow Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/MaxFlow/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/MaxFlow/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PumpConfigurationAndControl Cluster MaxFlow Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MaxFlow attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/MaxFlow/+'

# Example output

ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MaxFlow/Desired { "value": <DESIRED_MAX_FLOW>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MaxFlow/Reported { "value": <REPORTED_MAX_FLOW>}

\subsection pump_configuration_and_control_attr_min_const_pressure PumpConfigurationAndControl/MinConstPressure Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/MinConstPressure/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/MinConstPressure/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PumpConfigurationAndControl Cluster MinConstPressure Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MinConstPressure attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/MinConstPressure/+'

# Example output

ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MinConstPressure/Desired { "value": <DESIRED_MIN_CONST_PRESSURE>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MinConstPressure/Reported { "value": <REPORTED_MIN_CONST_PRESSURE>}

\subsection pump_configuration_and_control_attr_max_const_pressure PumpConfigurationAndControl/MaxConstPressure Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/MaxConstPressure/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/MaxConstPressure/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PumpConfigurationAndControl Cluster MaxConstPressure Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MaxConstPressure attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/MaxConstPressure/+'

# Example output

ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MaxConstPressure/Desired { "value": <DESIRED_MAX_CONST_PRESSURE>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MaxConstPressure/Reported { "value": <REPORTED_MAX_CONST_PRESSURE>}

\subsection pump_configuration_and_control_attr_min_comp_pressure PumpConfigurationAndControl/MinCompPressure Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/MinCompPressure/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/MinCompPressure/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PumpConfigurationAndControl Cluster MinCompPressure Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MinCompPressure attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/MinCompPressure/+'

# Example output

ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MinCompPressure/Desired { "value": <DESIRED_MIN_COMP_PRESSURE>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MinCompPressure/Reported { "value": <REPORTED_MIN_COMP_PRESSURE>}

\subsection pump_configuration_and_control_attr_max_comp_pressure PumpConfigurationAndControl/MaxCompPressure Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/MaxCompPressure/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/MaxCompPressure/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PumpConfigurationAndControl Cluster MaxCompPressure Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MaxCompPressure attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/MaxCompPressure/+'

# Example output

ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MaxCompPressure/Desired { "value": <DESIRED_MAX_COMP_PRESSURE>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MaxCompPressure/Reported { "value": <REPORTED_MAX_COMP_PRESSURE>}

\subsection pump_configuration_and_control_attr_min_const_speed PumpConfigurationAndControl/MinConstSpeed Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/MinConstSpeed/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/MinConstSpeed/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PumpConfigurationAndControl Cluster MinConstSpeed Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MinConstSpeed attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/MinConstSpeed/+'

# Example output

ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MinConstSpeed/Desired { "value": <DESIRED_MIN_CONST_SPEED>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MinConstSpeed/Reported { "value": <REPORTED_MIN_CONST_SPEED>}

\subsection pump_configuration_and_control_attr_max_const_speed PumpConfigurationAndControl/MaxConstSpeed Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/MaxConstSpeed/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/MaxConstSpeed/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PumpConfigurationAndControl Cluster MaxConstSpeed Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MaxConstSpeed attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/MaxConstSpeed/+'

# Example output

ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MaxConstSpeed/Desired { "value": <DESIRED_MAX_CONST_SPEED>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MaxConstSpeed/Reported { "value": <REPORTED_MAX_CONST_SPEED>}

\subsection pump_configuration_and_control_attr_min_const_flow PumpConfigurationAndControl/MinConstFlow Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/MinConstFlow/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/MinConstFlow/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PumpConfigurationAndControl Cluster MinConstFlow Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MinConstFlow attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/MinConstFlow/+'

# Example output

ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MinConstFlow/Desired { "value": <DESIRED_MIN_CONST_FLOW>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MinConstFlow/Reported { "value": <REPORTED_MIN_CONST_FLOW>}

\subsection pump_configuration_and_control_attr_max_const_flow PumpConfigurationAndControl/MaxConstFlow Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/MaxConstFlow/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/MaxConstFlow/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PumpConfigurationAndControl Cluster MaxConstFlow Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MaxConstFlow attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/MaxConstFlow/+'

# Example output

ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MaxConstFlow/Desired { "value": <DESIRED_MAX_CONST_FLOW>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MaxConstFlow/Reported { "value": <REPORTED_MAX_CONST_FLOW>}

\subsection pump_configuration_and_control_attr_min_const_temp PumpConfigurationAndControl/MinConstTemp Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/MinConstTemp/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/MinConstTemp/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PumpConfigurationAndControl Cluster MinConstTemp Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MinConstTemp attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/MinConstTemp/+'

# Example output

ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MinConstTemp/Desired { "value": <DESIRED_MIN_CONST_TEMP>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MinConstTemp/Reported { "value": <REPORTED_MIN_CONST_TEMP>}

\subsection pump_configuration_and_control_attr_max_const_temp PumpConfigurationAndControl/MaxConstTemp Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/MaxConstTemp/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/MaxConstTemp/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PumpConfigurationAndControl Cluster MaxConstTemp Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MaxConstTemp attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/MaxConstTemp/+'

# Example output

ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MaxConstTemp/Desired { "value": <DESIRED_MAX_CONST_TEMP>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MaxConstTemp/Reported { "value": <REPORTED_MAX_CONST_TEMP>}

\subsection pump_configuration_and_control_attr_pump_status PumpConfigurationAndControl/PumpStatus Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/PumpStatus/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/PumpStatus/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PumpConfigurationAndControl Cluster PumpStatus Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "PumpConfigurationAndControlPumpStatus"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for PumpStatus attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/PumpStatus/+'

# Example output

ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/PumpStatus/Desired { "value": <DESIRED_PUMP_STATUS>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/PumpStatus/Reported { "value": <REPORTED_PUMP_STATUS>}

\subsection pump_configuration_and_control_attr_effective_operation_mode PumpConfigurationAndControl/EffectiveOperationMode Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/EffectiveOperationMode/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/EffectiveOperationMode/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PumpConfigurationAndControl Cluster EffectiveOperationMode Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "PumpOperationMode"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for EffectiveOperationMode attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/EffectiveOperationMode/+'

# Example output

ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/EffectiveOperationMode/Desired { "value": <DESIRED_EFFECTIVE_OPERATION_MODE>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/EffectiveOperationMode/Reported { "value": <REPORTED_EFFECTIVE_OPERATION_MODE>}

\subsection pump_configuration_and_control_attr_effective_control_mode PumpConfigurationAndControl/EffectiveControlMode Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/EffectiveControlMode/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/EffectiveControlMode/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PumpConfigurationAndControl Cluster EffectiveControlMode Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "PumpControlMode"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for EffectiveControlMode attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/EffectiveControlMode/+'

# Example output

ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/EffectiveControlMode/Desired { "value": <DESIRED_EFFECTIVE_CONTROL_MODE>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/EffectiveControlMode/Reported { "value": <REPORTED_EFFECTIVE_CONTROL_MODE>}

\subsection pump_configuration_and_control_attr_capacity PumpConfigurationAndControl/Capacity Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/Capacity/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/Capacity/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PumpConfigurationAndControl Cluster Capacity Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Capacity attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/Capacity/+'

# Example output

ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/Capacity/Desired { "value": <DESIRED_CAPACITY>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/Capacity/Reported { "value": <REPORTED_CAPACITY>}

\subsection pump_configuration_and_control_attr_speed PumpConfigurationAndControl/Speed Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/Speed/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/Speed/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PumpConfigurationAndControl Cluster Speed Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Speed attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/Speed/+'

# Example output

ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/Speed/Desired { "value": <DESIRED_SPEED>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/Speed/Reported { "value": <REPORTED_SPEED>}

\subsection pump_configuration_and_control_attr_lifetime_running_hours PumpConfigurationAndControl/LifetimeRunningHours Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/LifetimeRunningHours/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/LifetimeRunningHours/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PumpConfigurationAndControl Cluster LifetimeRunningHours Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for LifetimeRunningHours attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/LifetimeRunningHours/+'

# Example output

ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/LifetimeRunningHours/Desired { "value": <DESIRED_LIFETIME_RUNNING_HOURS>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/LifetimeRunningHours/Reported { "value": <REPORTED_LIFETIME_RUNNING_HOURS>}

\subsection pump_configuration_and_control_attr_power PumpConfigurationAndControl/Power Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/Power/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/Power/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PumpConfigurationAndControl Cluster Power Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Power attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/Power/+'

# Example output

ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/Power/Desired { "value": <DESIRED_POWER>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/Power/Reported { "value": <REPORTED_POWER>}

\subsection pump_configuration_and_control_attr_lifetime_energy_consumed PumpConfigurationAndControl/LifetimeEnergyConsumed Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/LifetimeEnergyConsumed/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/LifetimeEnergyConsumed/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PumpConfigurationAndControl Cluster LifetimeEnergyConsumed Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for LifetimeEnergyConsumed attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/LifetimeEnergyConsumed/+'

# Example output

ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/LifetimeEnergyConsumed/Desired { "value": <DESIRED_LIFETIME_ENERGY_CONSUMED>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/LifetimeEnergyConsumed/Reported { "value": <REPORTED_LIFETIME_ENERGY_CONSUMED>}

\subsection pump_configuration_and_control_attr_operation_mode PumpConfigurationAndControl/OperationMode Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/OperationMode/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/OperationMode/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PumpConfigurationAndControl Cluster OperationMode Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "PumpOperationMode"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for OperationMode attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/OperationMode/+'

# Example output

ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/OperationMode/Desired { "value": <DESIRED_OPERATION_MODE>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/OperationMode/Reported { "value": <REPORTED_OPERATION_MODE>}

\subsection pump_configuration_and_control_attr_control_mode PumpConfigurationAndControl/ControlMode Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/ControlMode/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/ControlMode/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PumpConfigurationAndControl Cluster ControlMode Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "PumpControlMode"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ControlMode attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/ControlMode/+'

# Example output

ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/ControlMode/Desired { "value": <DESIRED_CONTROL_MODE>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/ControlMode/Reported { "value": <REPORTED_CONTROL_MODE>}

\subsection pump_configuration_and_control_attr_alarm_mask PumpConfigurationAndControl/AlarmMask Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/AlarmMask/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/AlarmMask/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PumpConfigurationAndControl Cluster AlarmMask Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "PumpConfigurationAndControlAlarmMask"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for AlarmMask attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/AlarmMask/+'

# Example output

ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/AlarmMask/Desired { "value": <DESIRED_ALARM_MASK>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/AlarmMask/Reported { "value": <REPORTED_ALARM_MASK>}

\subsection pump_configuration_and_control_attr_cluster_revision PumpConfigurationAndControl/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/ClusterRevision/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PumpConfigurationAndControl Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/PumpConfigurationAndControl/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/PumpConfigurationAndControl/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/PumpConfigurationAndControl/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section pump_configuration_and_control_recv_cmd_support PumpConfigurationAndControl Command Support

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/SupportedCommands
[PREFIX]/PumpConfigurationAndControl/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PumpConfigurationAndControl Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for PumpConfigurationAndControl cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/PumpConfigurationAndControl/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/PumpConfigurationAndControl/SupportedCommands { "value": [] }

To see supported generated commands for PumpConfigurationAndControl cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/PumpConfigurationAndControl/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/PumpConfigurationAndControl/SupportedGeneratedCommands { "value": [] }

\section pump_configuration_and_control_cmds PumpConfigurationAndControl Commands

\subsection pump_configuration_and_control_write_attr_cmd PumpConfigurationAndControl/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PumpConfigurationAndControl Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
    "LifetimeRunningHours": {
      "type": "integer"
    },
    "Power": {
      "type": "integer"
    },
    "OperationMode": {
      "type": "PumpOperationMode"
    },
    "ControlMode": {
      "type": "PumpControlMode"
    },
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all PumpConfigurationAndControl attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/PumpConfigurationAndControl/Commands/WriteAttributes' -m  '{ "LifetimeRunningHours": <LIFETIME_RUNNING_HOURS_VALUE> ,"Power": <POWER_VALUE> ,"OperationMode": <OPERATION_MODE_VALUE> ,"ControlMode": <CONTROL_MODE_VALUE> , }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection pump_configuration_and_control_force_read_attr_cmd PumpConfigurationAndControl/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PumpConfigurationAndControl Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "MaxPressure",
          "MaxSpeed",
          "MaxFlow",
          "MinConstPressure",
          "MaxConstPressure",
          "MinCompPressure",
          "MaxCompPressure",
          "MinConstSpeed",
          "MaxConstSpeed",
          "MinConstFlow",
          "MaxConstFlow",
          "MinConstTemp",
          "MaxConstTemp",
          "PumpStatus",
          "EffectiveOperationMode",
          "EffectiveControlMode",
          "Capacity",
          "Speed",
          "LifetimeRunningHours",
          "Power",
          "LifetimeEnergyConsumed",
          "OperationMode",
          "ControlMode",
          "AlarmMask"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all PumpConfigurationAndControl attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/PumpConfigurationAndControl/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the PumpConfigurationAndControl attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/PumpConfigurationAndControl/Commands/ForceReadAttributes' -m  '{ "value": ["MaxPressure"] }'

\page thermostat Thermostat Cluster The following commands and attributes are accepted as JSON payloads for the Thermostat cluster.

\section thermostat_attrs Thermostat Attributes The following attribute topics are used to retrieve the Thermostat cluster state.

\subsection thermostat_attr_local_temperature Thermostat/LocalTemperature Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/LocalTemperature/Reported
[PREFIX]/Thermostat/Attributes/LocalTemperature/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster LocalTemperature Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for LocalTemperature attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/LocalTemperature/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/LocalTemperature/Desired { "value": <DESIRED_LOCAL_TEMPERATURE>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/LocalTemperature/Reported { "value": <REPORTED_LOCAL_TEMPERATURE>}

\subsection thermostat_attr_outdoor_temperature Thermostat/OutdoorTemperature Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/OutdoorTemperature/Reported
[PREFIX]/Thermostat/Attributes/OutdoorTemperature/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster OutdoorTemperature Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for OutdoorTemperature attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/OutdoorTemperature/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/OutdoorTemperature/Desired { "value": <DESIRED_OUTDOOR_TEMPERATURE>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/OutdoorTemperature/Reported { "value": <REPORTED_OUTDOOR_TEMPERATURE>}

\subsection thermostat_attr_occupancy Thermostat/Occupancy Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/Occupancy/Reported
[PREFIX]/Thermostat/Attributes/Occupancy/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster Occupancy Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ThermostatOccupancy"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Occupancy attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/Occupancy/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/Occupancy/Desired { "value": <DESIRED_OCCUPANCY>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/Occupancy/Reported { "value": <REPORTED_OCCUPANCY>}

\subsection thermostat_attr_abs_min_heat_setpoint_limit Thermostat/AbsMinHeatSetpointLimit Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/AbsMinHeatSetpointLimit/Reported
[PREFIX]/Thermostat/Attributes/AbsMinHeatSetpointLimit/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster AbsMinHeatSetpointLimit Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for AbsMinHeatSetpointLimit attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/AbsMinHeatSetpointLimit/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/AbsMinHeatSetpointLimit/Desired { "value": <DESIRED_ABS_MIN_HEAT_SETPOINT_LIMIT>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/AbsMinHeatSetpointLimit/Reported { "value": <REPORTED_ABS_MIN_HEAT_SETPOINT_LIMIT>}

\subsection thermostat_attr_abs_max_heat_setpoint_limit Thermostat/AbsMaxHeatSetpointLimit Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/AbsMaxHeatSetpointLimit/Reported
[PREFIX]/Thermostat/Attributes/AbsMaxHeatSetpointLimit/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster AbsMaxHeatSetpointLimit Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for AbsMaxHeatSetpointLimit attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/AbsMaxHeatSetpointLimit/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/AbsMaxHeatSetpointLimit/Desired { "value": <DESIRED_ABS_MAX_HEAT_SETPOINT_LIMIT>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/AbsMaxHeatSetpointLimit/Reported { "value": <REPORTED_ABS_MAX_HEAT_SETPOINT_LIMIT>}

\subsection thermostat_attr_abs_min_cool_setpoint_limit Thermostat/AbsMinCoolSetpointLimit Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/AbsMinCoolSetpointLimit/Reported
[PREFIX]/Thermostat/Attributes/AbsMinCoolSetpointLimit/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster AbsMinCoolSetpointLimit Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for AbsMinCoolSetpointLimit attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/AbsMinCoolSetpointLimit/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/AbsMinCoolSetpointLimit/Desired { "value": <DESIRED_ABS_MIN_COOL_SETPOINT_LIMIT>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/AbsMinCoolSetpointLimit/Reported { "value": <REPORTED_ABS_MIN_COOL_SETPOINT_LIMIT>}

\subsection thermostat_attr_abs_max_cool_setpoint_limit Thermostat/AbsMaxCoolSetpointLimit Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/AbsMaxCoolSetpointLimit/Reported
[PREFIX]/Thermostat/Attributes/AbsMaxCoolSetpointLimit/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster AbsMaxCoolSetpointLimit Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for AbsMaxCoolSetpointLimit attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/AbsMaxCoolSetpointLimit/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/AbsMaxCoolSetpointLimit/Desired { "value": <DESIRED_ABS_MAX_COOL_SETPOINT_LIMIT>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/AbsMaxCoolSetpointLimit/Reported { "value": <REPORTED_ABS_MAX_COOL_SETPOINT_LIMIT>}

\subsection thermostat_attr_pi_cooling_demand Thermostat/PICoolingDemand Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/PICoolingDemand/Reported
[PREFIX]/Thermostat/Attributes/PICoolingDemand/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster PICoolingDemand Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for PICoolingDemand attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/PICoolingDemand/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/PICoolingDemand/Desired { "value": <DESIRED_PI_COOLING_DEMAND>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/PICoolingDemand/Reported { "value": <REPORTED_PI_COOLING_DEMAND>}

\subsection thermostat_attr_pi_heating_demand Thermostat/PIHeatingDemand Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/PIHeatingDemand/Reported
[PREFIX]/Thermostat/Attributes/PIHeatingDemand/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster PIHeatingDemand Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for PIHeatingDemand attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/PIHeatingDemand/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/PIHeatingDemand/Desired { "value": <DESIRED_PI_HEATING_DEMAND>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/PIHeatingDemand/Reported { "value": <REPORTED_PI_HEATING_DEMAND>}

\subsection thermostat_attr_hvac_system_type_configuration Thermostat/HVACSystemTypeConfiguration Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/HVACSystemTypeConfiguration/Reported
[PREFIX]/Thermostat/Attributes/HVACSystemTypeConfiguration/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster HVACSystemTypeConfiguration Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ThermostatHVACSystemTypeConfiguration"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for HVACSystemTypeConfiguration attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/HVACSystemTypeConfiguration/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/HVACSystemTypeConfiguration/Desired { "value": <DESIRED_HVAC_SYSTEM_TYPE_CONFIGURATION>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/HVACSystemTypeConfiguration/Reported { "value": <REPORTED_HVAC_SYSTEM_TYPE_CONFIGURATION>}

\subsection thermostat_attr_local_temperature_calibration Thermostat/LocalTemperatureCalibration Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/LocalTemperatureCalibration/Reported
[PREFIX]/Thermostat/Attributes/LocalTemperatureCalibration/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster LocalTemperatureCalibration Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for LocalTemperatureCalibration attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/LocalTemperatureCalibration/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/LocalTemperatureCalibration/Desired { "value": <DESIRED_LOCAL_TEMPERATURE_CALIBRATION>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/LocalTemperatureCalibration/Reported { "value": <REPORTED_LOCAL_TEMPERATURE_CALIBRATION>}

\subsection thermostat_attr_occupied_cooling_setpoint Thermostat/OccupiedCoolingSetpoint Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/OccupiedCoolingSetpoint/Reported
[PREFIX]/Thermostat/Attributes/OccupiedCoolingSetpoint/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster OccupiedCoolingSetpoint Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for OccupiedCoolingSetpoint attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/OccupiedCoolingSetpoint/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/OccupiedCoolingSetpoint/Desired { "value": <DESIRED_OCCUPIED_COOLING_SETPOINT>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/OccupiedCoolingSetpoint/Reported { "value": <REPORTED_OCCUPIED_COOLING_SETPOINT>}

\subsection thermostat_attr_occupied_heating_setpoint Thermostat/OccupiedHeatingSetpoint Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/OccupiedHeatingSetpoint/Reported
[PREFIX]/Thermostat/Attributes/OccupiedHeatingSetpoint/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster OccupiedHeatingSetpoint Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for OccupiedHeatingSetpoint attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/OccupiedHeatingSetpoint/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/OccupiedHeatingSetpoint/Desired { "value": <DESIRED_OCCUPIED_HEATING_SETPOINT>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/OccupiedHeatingSetpoint/Reported { "value": <REPORTED_OCCUPIED_HEATING_SETPOINT>}

\subsection thermostat_attr_unoccupied_cooling_setpoint Thermostat/UnoccupiedCoolingSetpoint Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/UnoccupiedCoolingSetpoint/Reported
[PREFIX]/Thermostat/Attributes/UnoccupiedCoolingSetpoint/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster UnoccupiedCoolingSetpoint Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for UnoccupiedCoolingSetpoint attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/UnoccupiedCoolingSetpoint/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/UnoccupiedCoolingSetpoint/Desired { "value": <DESIRED_UNOCCUPIED_COOLING_SETPOINT>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/UnoccupiedCoolingSetpoint/Reported { "value": <REPORTED_UNOCCUPIED_COOLING_SETPOINT>}

\subsection thermostat_attr_unoccupied_heating_setpoint Thermostat/UnoccupiedHeatingSetpoint Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/UnoccupiedHeatingSetpoint/Reported
[PREFIX]/Thermostat/Attributes/UnoccupiedHeatingSetpoint/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster UnoccupiedHeatingSetpoint Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for UnoccupiedHeatingSetpoint attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/UnoccupiedHeatingSetpoint/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/UnoccupiedHeatingSetpoint/Desired { "value": <DESIRED_UNOCCUPIED_HEATING_SETPOINT>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/UnoccupiedHeatingSetpoint/Reported { "value": <REPORTED_UNOCCUPIED_HEATING_SETPOINT>}

\subsection thermostat_attr_min_heat_setpoint_limit Thermostat/MinHeatSetpointLimit Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/MinHeatSetpointLimit/Reported
[PREFIX]/Thermostat/Attributes/MinHeatSetpointLimit/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster MinHeatSetpointLimit Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MinHeatSetpointLimit attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/MinHeatSetpointLimit/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/MinHeatSetpointLimit/Desired { "value": <DESIRED_MIN_HEAT_SETPOINT_LIMIT>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/MinHeatSetpointLimit/Reported { "value": <REPORTED_MIN_HEAT_SETPOINT_LIMIT>}

\subsection thermostat_attr_max_heat_setpoint_limit Thermostat/MaxHeatSetpointLimit Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/MaxHeatSetpointLimit/Reported
[PREFIX]/Thermostat/Attributes/MaxHeatSetpointLimit/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster MaxHeatSetpointLimit Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MaxHeatSetpointLimit attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/MaxHeatSetpointLimit/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/MaxHeatSetpointLimit/Desired { "value": <DESIRED_MAX_HEAT_SETPOINT_LIMIT>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/MaxHeatSetpointLimit/Reported { "value": <REPORTED_MAX_HEAT_SETPOINT_LIMIT>}

\subsection thermostat_attr_min_cool_setpoint_limit Thermostat/MinCoolSetpointLimit Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/MinCoolSetpointLimit/Reported
[PREFIX]/Thermostat/Attributes/MinCoolSetpointLimit/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster MinCoolSetpointLimit Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MinCoolSetpointLimit attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/MinCoolSetpointLimit/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/MinCoolSetpointLimit/Desired { "value": <DESIRED_MIN_COOL_SETPOINT_LIMIT>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/MinCoolSetpointLimit/Reported { "value": <REPORTED_MIN_COOL_SETPOINT_LIMIT>}

\subsection thermostat_attr_max_cool_setpoint_limit Thermostat/MaxCoolSetpointLimit Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/MaxCoolSetpointLimit/Reported
[PREFIX]/Thermostat/Attributes/MaxCoolSetpointLimit/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster MaxCoolSetpointLimit Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MaxCoolSetpointLimit attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/MaxCoolSetpointLimit/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/MaxCoolSetpointLimit/Desired { "value": <DESIRED_MAX_COOL_SETPOINT_LIMIT>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/MaxCoolSetpointLimit/Reported { "value": <REPORTED_MAX_COOL_SETPOINT_LIMIT>}

\subsection thermostat_attr_min_setpoint_dead_band Thermostat/MinSetpointDeadBand Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/MinSetpointDeadBand/Reported
[PREFIX]/Thermostat/Attributes/MinSetpointDeadBand/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster MinSetpointDeadBand Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MinSetpointDeadBand attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/MinSetpointDeadBand/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/MinSetpointDeadBand/Desired { "value": <DESIRED_MIN_SETPOINT_DEAD_BAND>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/MinSetpointDeadBand/Reported { "value": <REPORTED_MIN_SETPOINT_DEAD_BAND>}

\subsection thermostat_attr_remote_sensing Thermostat/RemoteSensing Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/RemoteSensing/Reported
[PREFIX]/Thermostat/Attributes/RemoteSensing/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster RemoteSensing Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ThermostatRemoteSensing"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RemoteSensing attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/RemoteSensing/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/RemoteSensing/Desired { "value": <DESIRED_REMOTE_SENSING>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/RemoteSensing/Reported { "value": <REPORTED_REMOTE_SENSING>}

\subsection thermostat_attr_control_sequence_of_operation Thermostat/ControlSequenceOfOperation Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/ControlSequenceOfOperation/Reported
[PREFIX]/Thermostat/Attributes/ControlSequenceOfOperation/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster ControlSequenceOfOperation Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ThermostatControlSequenceOfOperation"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ControlSequenceOfOperation attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/ControlSequenceOfOperation/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ControlSequenceOfOperation/Desired { "value": <DESIRED_CONTROL_SEQUENCE_OF_OPERATION>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ControlSequenceOfOperation/Reported { "value": <REPORTED_CONTROL_SEQUENCE_OF_OPERATION>}

\subsection thermostat_attr_system_mode Thermostat/SystemMode Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/SystemMode/Reported
[PREFIX]/Thermostat/Attributes/SystemMode/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster SystemMode Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ThermostatSystemMode"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for SystemMode attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/SystemMode/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/SystemMode/Desired { "value": <DESIRED_SYSTEM_MODE>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/SystemMode/Reported { "value": <REPORTED_SYSTEM_MODE>}

\subsection thermostat_attr_alarm_mask Thermostat/AlarmMask Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/AlarmMask/Reported
[PREFIX]/Thermostat/Attributes/AlarmMask/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster AlarmMask Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ThermostatAlarmMask"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for AlarmMask attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/AlarmMask/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/AlarmMask/Desired { "value": <DESIRED_ALARM_MASK>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/AlarmMask/Reported { "value": <REPORTED_ALARM_MASK>}

\subsection thermostat_attr_thermostat_running_mode Thermostat/ThermostatRunningMode Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/ThermostatRunningMode/Reported
[PREFIX]/Thermostat/Attributes/ThermostatRunningMode/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster ThermostatRunningMode Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ThermostatThermostatRunningMode"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ThermostatRunningMode attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/ThermostatRunningMode/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ThermostatRunningMode/Desired { "value": <DESIRED_THERMOSTAT_RUNNING_MODE>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ThermostatRunningMode/Reported { "value": <REPORTED_THERMOSTAT_RUNNING_MODE>}

\subsection thermostat_attr_start_of_week Thermostat/StartOfWeek Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/StartOfWeek/Reported
[PREFIX]/Thermostat/Attributes/StartOfWeek/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster StartOfWeek Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ThermostatStartOfWeek"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for StartOfWeek attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/StartOfWeek/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/StartOfWeek/Desired { "value": <DESIRED_START_OF_WEEK>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/StartOfWeek/Reported { "value": <REPORTED_START_OF_WEEK>}

\subsection thermostat_attr_number_of_weekly_transitions Thermostat/NumberOfWeeklyTransitions Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/NumberOfWeeklyTransitions/Reported
[PREFIX]/Thermostat/Attributes/NumberOfWeeklyTransitions/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster NumberOfWeeklyTransitions Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for NumberOfWeeklyTransitions attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/NumberOfWeeklyTransitions/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/NumberOfWeeklyTransitions/Desired { "value": <DESIRED_NUMBER_OF_WEEKLY_TRANSITIONS>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/NumberOfWeeklyTransitions/Reported { "value": <REPORTED_NUMBER_OF_WEEKLY_TRANSITIONS>}

\subsection thermostat_attr_number_of_daily_transitions Thermostat/NumberOfDailyTransitions Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/NumberOfDailyTransitions/Reported
[PREFIX]/Thermostat/Attributes/NumberOfDailyTransitions/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster NumberOfDailyTransitions Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for NumberOfDailyTransitions attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/NumberOfDailyTransitions/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/NumberOfDailyTransitions/Desired { "value": <DESIRED_NUMBER_OF_DAILY_TRANSITIONS>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/NumberOfDailyTransitions/Reported { "value": <REPORTED_NUMBER_OF_DAILY_TRANSITIONS>}

\subsection thermostat_attr_temperature_setpoint_hold Thermostat/TemperatureSetpointHold Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/TemperatureSetpointHold/Reported
[PREFIX]/Thermostat/Attributes/TemperatureSetpointHold/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster TemperatureSetpointHold Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ThermostatTemperatureSetpointHold"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for TemperatureSetpointHold attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/TemperatureSetpointHold/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/TemperatureSetpointHold/Desired { "value": <DESIRED_TEMPERATURE_SETPOINT_HOLD>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/TemperatureSetpointHold/Reported { "value": <REPORTED_TEMPERATURE_SETPOINT_HOLD>}

\subsection thermostat_attr_temperature_setpoint_hold_duration Thermostat/TemperatureSetpointHoldDuration Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/TemperatureSetpointHoldDuration/Reported
[PREFIX]/Thermostat/Attributes/TemperatureSetpointHoldDuration/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster TemperatureSetpointHoldDuration Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for TemperatureSetpointHoldDuration attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/TemperatureSetpointHoldDuration/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/TemperatureSetpointHoldDuration/Desired { "value": <DESIRED_TEMPERATURE_SETPOINT_HOLD_DURATION>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/TemperatureSetpointHoldDuration/Reported { "value": <REPORTED_TEMPERATURE_SETPOINT_HOLD_DURATION>}

\subsection thermostat_attr_thermostat_programming_operation_mode Thermostat/ThermostatProgrammingOperationMode Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/ThermostatProgrammingOperationMode/Reported
[PREFIX]/Thermostat/Attributes/ThermostatProgrammingOperationMode/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster ThermostatProgrammingOperationMode Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ThermostatThermostatProgrammingOperationMode"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ThermostatProgrammingOperationMode attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/ThermostatProgrammingOperationMode/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ThermostatProgrammingOperationMode/Desired { "value": <DESIRED_THERMOSTAT_PROGRAMMING_OPERATION_MODE>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ThermostatProgrammingOperationMode/Reported { "value": <REPORTED_THERMOSTAT_PROGRAMMING_OPERATION_MODE>}

\subsection thermostat_attr_thermostat_running_state Thermostat/ThermostatRunningState Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/ThermostatRunningState/Reported
[PREFIX]/Thermostat/Attributes/ThermostatRunningState/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster ThermostatRunningState Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ThermostatThermostatRunningState"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ThermostatRunningState attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/ThermostatRunningState/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ThermostatRunningState/Desired { "value": <DESIRED_THERMOSTAT_RUNNING_STATE>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ThermostatRunningState/Reported { "value": <REPORTED_THERMOSTAT_RUNNING_STATE>}

\subsection thermostat_attr_setpoint_change_source Thermostat/SetpointChangeSource Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/SetpointChangeSource/Reported
[PREFIX]/Thermostat/Attributes/SetpointChangeSource/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster SetpointChangeSource Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ThermostatSetpointChangeSource"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for SetpointChangeSource attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/SetpointChangeSource/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/SetpointChangeSource/Desired { "value": <DESIRED_SETPOINT_CHANGE_SOURCE>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/SetpointChangeSource/Reported { "value": <REPORTED_SETPOINT_CHANGE_SOURCE>}

\subsection thermostat_attr_setpoint_change_amount Thermostat/SetpointChangeAmount Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/SetpointChangeAmount/Reported
[PREFIX]/Thermostat/Attributes/SetpointChangeAmount/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster SetpointChangeAmount Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for SetpointChangeAmount attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/SetpointChangeAmount/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/SetpointChangeAmount/Desired { "value": <DESIRED_SETPOINT_CHANGE_AMOUNT>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/SetpointChangeAmount/Reported { "value": <REPORTED_SETPOINT_CHANGE_AMOUNT>}

\subsection thermostat_attr_setpoint_change_source_timestamp Thermostat/SetpointChangeSourceTimestamp Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/SetpointChangeSourceTimestamp/Reported
[PREFIX]/Thermostat/Attributes/SetpointChangeSourceTimestamp/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster SetpointChangeSourceTimestamp Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "UTC"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for SetpointChangeSourceTimestamp attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/SetpointChangeSourceTimestamp/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/SetpointChangeSourceTimestamp/Desired { "value": <DESIRED_SETPOINT_CHANGE_SOURCE_TIMESTAMP>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/SetpointChangeSourceTimestamp/Reported { "value": <REPORTED_SETPOINT_CHANGE_SOURCE_TIMESTAMP>}

\subsection thermostat_attr_occupied_setback Thermostat/OccupiedSetback Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/OccupiedSetback/Reported
[PREFIX]/Thermostat/Attributes/OccupiedSetback/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster OccupiedSetback Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for OccupiedSetback attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/OccupiedSetback/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/OccupiedSetback/Desired { "value": <DESIRED_OCCUPIED_SETBACK>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/OccupiedSetback/Reported { "value": <REPORTED_OCCUPIED_SETBACK>}

\subsection thermostat_attr_occupied_setback_min Thermostat/OccupiedSetbackMin Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/OccupiedSetbackMin/Reported
[PREFIX]/Thermostat/Attributes/OccupiedSetbackMin/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster OccupiedSetbackMin Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for OccupiedSetbackMin attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/OccupiedSetbackMin/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/OccupiedSetbackMin/Desired { "value": <DESIRED_OCCUPIED_SETBACK_MIN>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/OccupiedSetbackMin/Reported { "value": <REPORTED_OCCUPIED_SETBACK_MIN>}

\subsection thermostat_attr_occupied_setback_max Thermostat/OccupiedSetbackMax Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/OccupiedSetbackMax/Reported
[PREFIX]/Thermostat/Attributes/OccupiedSetbackMax/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster OccupiedSetbackMax Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for OccupiedSetbackMax attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/OccupiedSetbackMax/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/OccupiedSetbackMax/Desired { "value": <DESIRED_OCCUPIED_SETBACK_MAX>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/OccupiedSetbackMax/Reported { "value": <REPORTED_OCCUPIED_SETBACK_MAX>}

\subsection thermostat_attr_unoccupied_setback Thermostat/UnoccupiedSetback Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/UnoccupiedSetback/Reported
[PREFIX]/Thermostat/Attributes/UnoccupiedSetback/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster UnoccupiedSetback Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for UnoccupiedSetback attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/UnoccupiedSetback/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/UnoccupiedSetback/Desired { "value": <DESIRED_UNOCCUPIED_SETBACK>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/UnoccupiedSetback/Reported { "value": <REPORTED_UNOCCUPIED_SETBACK>}

\subsection thermostat_attr_unoccupied_setback_min Thermostat/UnoccupiedSetbackMin Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/UnoccupiedSetbackMin/Reported
[PREFIX]/Thermostat/Attributes/UnoccupiedSetbackMin/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster UnoccupiedSetbackMin Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for UnoccupiedSetbackMin attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/UnoccupiedSetbackMin/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/UnoccupiedSetbackMin/Desired { "value": <DESIRED_UNOCCUPIED_SETBACK_MIN>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/UnoccupiedSetbackMin/Reported { "value": <REPORTED_UNOCCUPIED_SETBACK_MIN>}

\subsection thermostat_attr_unoccupied_setback_max Thermostat/UnoccupiedSetbackMax Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/UnoccupiedSetbackMax/Reported
[PREFIX]/Thermostat/Attributes/UnoccupiedSetbackMax/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster UnoccupiedSetbackMax Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for UnoccupiedSetbackMax attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/UnoccupiedSetbackMax/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/UnoccupiedSetbackMax/Desired { "value": <DESIRED_UNOCCUPIED_SETBACK_MAX>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/UnoccupiedSetbackMax/Reported { "value": <REPORTED_UNOCCUPIED_SETBACK_MAX>}

\subsection thermostat_attr_emergency_heat_delta Thermostat/EmergencyHeatDelta Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/EmergencyHeatDelta/Reported
[PREFIX]/Thermostat/Attributes/EmergencyHeatDelta/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster EmergencyHeatDelta Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for EmergencyHeatDelta attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/EmergencyHeatDelta/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/EmergencyHeatDelta/Desired { "value": <DESIRED_EMERGENCY_HEAT_DELTA>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/EmergencyHeatDelta/Reported { "value": <REPORTED_EMERGENCY_HEAT_DELTA>}

\subsection thermostat_attr_ac_type Thermostat/ACType Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/ACType/Reported
[PREFIX]/Thermostat/Attributes/ACType/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster ACType Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ThermostatACType"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ACType attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/ACType/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ACType/Desired { "value": <DESIRED_AC_TYPE>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ACType/Reported { "value": <REPORTED_AC_TYPE>}

\subsection thermostat_attr_ac_capacity Thermostat/ACCapacity Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/ACCapacity/Reported
[PREFIX]/Thermostat/Attributes/ACCapacity/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster ACCapacity Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ACCapacity attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/ACCapacity/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ACCapacity/Desired { "value": <DESIRED_AC_CAPACITY>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ACCapacity/Reported { "value": <REPORTED_AC_CAPACITY>}

\subsection thermostat_attr_ac_refrigerant_type Thermostat/ACRefrigerantType Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/ACRefrigerantType/Reported
[PREFIX]/Thermostat/Attributes/ACRefrigerantType/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster ACRefrigerantType Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ThermostatACRefrigerantType"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ACRefrigerantType attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/ACRefrigerantType/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ACRefrigerantType/Desired { "value": <DESIRED_AC_REFRIGERANT_TYPE>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ACRefrigerantType/Reported { "value": <REPORTED_AC_REFRIGERANT_TYPE>}

\subsection thermostat_attr_ac_compressor_type Thermostat/ACCompressorType Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/ACCompressorType/Reported
[PREFIX]/Thermostat/Attributes/ACCompressorType/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster ACCompressorType Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ThermostatACCompressorType"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ACCompressorType attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/ACCompressorType/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ACCompressorType/Desired { "value": <DESIRED_AC_COMPRESSOR_TYPE>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ACCompressorType/Reported { "value": <REPORTED_AC_COMPRESSOR_TYPE>}

\subsection thermostat_attr_ac_error_code Thermostat/ACErrorCode Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/ACErrorCode/Reported
[PREFIX]/Thermostat/Attributes/ACErrorCode/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster ACErrorCode Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ThermostatACErrorCode"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ACErrorCode attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/ACErrorCode/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ACErrorCode/Desired { "value": <DESIRED_AC_ERROR_CODE>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ACErrorCode/Reported { "value": <REPORTED_AC_ERROR_CODE>}

\subsection thermostat_attr_ac_louver_position Thermostat/ACLouverPosition Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/ACLouverPosition/Reported
[PREFIX]/Thermostat/Attributes/ACLouverPosition/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster ACLouverPosition Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ThermostatACLouverPosition"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ACLouverPosition attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/ACLouverPosition/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ACLouverPosition/Desired { "value": <DESIRED_AC_LOUVER_POSITION>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ACLouverPosition/Reported { "value": <REPORTED_AC_LOUVER_POSITION>}

\subsection thermostat_attr_ac_coil_temperature Thermostat/ACCoilTemperature Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/ACCoilTemperature/Reported
[PREFIX]/Thermostat/Attributes/ACCoilTemperature/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster ACCoilTemperature Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ACCoilTemperature attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/ACCoilTemperature/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ACCoilTemperature/Desired { "value": <DESIRED_AC_COIL_TEMPERATURE>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ACCoilTemperature/Reported { "value": <REPORTED_AC_COIL_TEMPERATURE>}

\subsection thermostat_attr_ac_capacity_format Thermostat/ACCapacityFormat Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/ACCapacityFormat/Reported
[PREFIX]/Thermostat/Attributes/ACCapacityFormat/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster ACCapacityFormat Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ThermostatACCapacityFormat"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ACCapacityFormat attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/ACCapacityFormat/+'

# Example output

ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ACCapacityFormat/Desired { "value": <DESIRED_AC_CAPACITY_FORMAT>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ACCapacityFormat/Reported { "value": <REPORTED_AC_CAPACITY_FORMAT>}

\subsection thermostat_attr_cluster_revision Thermostat/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/ClusterRevision/Reported
[PREFIX]/Thermostat/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Thermostat/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/Thermostat/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/Thermostat/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section thermostat_recv_cmd_support Thermostat Command Support

MQTT Topic Pattern:

[PREFIX]/Thermostat/SupportedCommands
[PREFIX]/Thermostat/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
              "SetpointRaiseOrLower",
              "GetWeeklyScheduleResponse",
              "SetWeeklySchedule",
              "GetRelayStatusLogResponse",
              "GetWeeklySchedule",
              "ClearWeeklySchedule",
              "GetRelayStatusLog",
              "WriteAttributes",
              "ForceReadAttributes"
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for Thermostat cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Thermostat/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/Thermostat/SupportedCommands { "value": ["SetpointRaiseOrLower","SetWeeklySchedule","GetWeeklySchedule","ClearWeeklySchedule","GetRelayStatusLog","WriteAttributes", "ForceReadAttributes"] }

To see supported generated commands for Thermostat cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Thermostat/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/Thermostat/SupportedGeneratedCommands { "value": ["GetWeeklyScheduleResponse","GetRelayStatusLogResponse",] }

\section thermostat_cmds Thermostat Commands

\subsection thermostat_setpoint_raise_or_lower_cmd Thermostat/SetpointRaiseOrLower Command

MQTT Topic Pattern:

[PREFIX]/Thermostat/Commands/SetpointRaiseOrLower
[PREFIX]/Thermostat/GeneratedCommands/SetpointRaiseOrLower

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster SetpointRaiseOrLower Command Properties",
  "type": "object",
  "properties": {
    "Mode": {
      "type": "SetpointRaiseOrLowerMode"
    },
    "Amount": {
      "type": "integer"
    }
  },
  "required": [
    "Mode",
    "Amount"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Thermostat/SetpointRaiseOrLower command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Thermostat/Commands/SetpointRaiseOrLower' -m  '{ "Mode": <MODE_VALUE>,"Amount": <AMOUNT_VALUE> }'

To receive a Thermostat/SetpointRaiseOrLower generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Thermostat/GeneratedCommands/SetpointRaiseOrLower'

\subsection thermostat_get_weekly_schedule_response_cmd Thermostat/GetWeeklyScheduleResponse Command

MQTT Topic Pattern:

[PREFIX]/Thermostat/Commands/GetWeeklyScheduleResponse
[PREFIX]/Thermostat/GeneratedCommands/GetWeeklyScheduleResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster GetWeeklyScheduleResponse Command Properties",
  "type": "object",
  "properties": {
    "NumberOfTransitions": {
      "type": "integer"
    },
    "DayOfWeek": {
      "type": "TstatScheduleDOW"
    },
    "Mode": {
      "type": "TstatScheduleMode"
    },
    "Transitions": {
      "type": "array",
      "items": {
        "type": "TransitionType"
      }

  },
  "required": [
    "NumberOfTransitions",
    "DayOfWeek",
    "Mode",
    "Transitions"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Thermostat/GetWeeklyScheduleResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Thermostat/Commands/GetWeeklyScheduleResponse' -m  '{ "NumberOfTransitions": <NUMBER_OF_TRANSITIONS_VALUE>,"DayOfWeek": <DAY_OF_WEEK_VALUE>,"Mode": <MODE_VALUE>,"Transitions": <TRANSITIONS_VALUE> }'

To receive a Thermostat/GetWeeklyScheduleResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Thermostat/GeneratedCommands/GetWeeklyScheduleResponse'

\subsection thermostat_set_weekly_schedule_cmd Thermostat/SetWeeklySchedule Command

MQTT Topic Pattern:

[PREFIX]/Thermostat/Commands/SetWeeklySchedule
[PREFIX]/Thermostat/GeneratedCommands/SetWeeklySchedule

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster SetWeeklySchedule Command Properties",
  "type": "object",
  "properties": {
    "NumberOfTransitions": {
      "type": "integer"
    },
    "DayOfWeek": {
      "type": "TstatScheduleDOW"
    },
    "Mode": {
      "type": "TstatScheduleMode"
    },
    "Transitions": {
      "type": "array",
      "items": {
        "type": "TransitionType"
      }

  },
  "required": [
    "NumberOfTransitions",
    "DayOfWeek",
    "Mode",
    "Transitions"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Thermostat/SetWeeklySchedule command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Thermostat/Commands/SetWeeklySchedule' -m  '{ "NumberOfTransitions": <NUMBER_OF_TRANSITIONS_VALUE>,"DayOfWeek": <DAY_OF_WEEK_VALUE>,"Mode": <MODE_VALUE>,"Transitions": <TRANSITIONS_VALUE> }'

To receive a Thermostat/SetWeeklySchedule generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Thermostat/GeneratedCommands/SetWeeklySchedule'

\subsection thermostat_get_relay_status_log_response_cmd Thermostat/GetRelayStatusLogResponse Command

MQTT Topic Pattern:

[PREFIX]/Thermostat/Commands/GetRelayStatusLogResponse
[PREFIX]/Thermostat/GeneratedCommands/GetRelayStatusLogResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster GetRelayStatusLogResponse Command Properties",
  "type": "object",
  "properties": {
    "TimeOfDay": {
      "type": "integer"
    },
    "RelayStatus": {
      "type": "GetRelayStatusLogResponseRelayStatus"
    },
    "LocalTemperature": {
      "type": "integer"
    },
    "HumidityPercentage": {
      "type": "integer"
    },
    "SetPoint": {
      "type": "integer"
    },
    "UnreadEntries": {
      "type": "integer"
    }
  },
  "required": [
    "TimeOfDay",
    "RelayStatus",
    "LocalTemperature",
    "HumidityPercentage",
    "SetPoint",
    "UnreadEntries"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Thermostat/GetRelayStatusLogResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Thermostat/Commands/GetRelayStatusLogResponse' -m  '{ "TimeOfDay": <TIME_OF_DAY_VALUE>,"RelayStatus": <RELAY_STATUS_VALUE>,"LocalTemperature": <LOCAL_TEMPERATURE_VALUE>,"HumidityPercentage": <HUMIDITY_PERCENTAGE_VALUE>,"SetPoint": <SET_POINT_VALUE>,"UnreadEntries": <UNREAD_ENTRIES_VALUE> }'

To receive a Thermostat/GetRelayStatusLogResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Thermostat/GeneratedCommands/GetRelayStatusLogResponse'

\subsection thermostat_get_weekly_schedule_cmd Thermostat/GetWeeklySchedule Command

MQTT Topic Pattern:

[PREFIX]/Thermostat/Commands/GetWeeklySchedule
[PREFIX]/Thermostat/GeneratedCommands/GetWeeklySchedule

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster GetWeeklySchedule Command Properties",
  "type": "object",
  "properties": {
    "DaysToReturn": {
      "type": "TstatScheduleDOW"
    },
    "ModeToReturn": {
      "type": "TstatScheduleMode"
    }
  },
  "required": [
    "DaysToReturn",
    "ModeToReturn"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Thermostat/GetWeeklySchedule command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Thermostat/Commands/GetWeeklySchedule' -m  '{ "DaysToReturn": <DAYS_TO_RETURN_VALUE>,"ModeToReturn": <MODE_TO_RETURN_VALUE> }'

To receive a Thermostat/GetWeeklySchedule generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Thermostat/GeneratedCommands/GetWeeklySchedule'

\subsection thermostat_clear_weekly_schedule_cmd Thermostat/ClearWeeklySchedule Command

MQTT Topic Pattern:

[PREFIX]/Thermostat/Commands/ClearWeeklySchedule
[PREFIX]/Thermostat/GeneratedCommands/ClearWeeklySchedule

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster ClearWeeklySchedule Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
  ]
}

Example Mosquitto CLI Tool Usage

To send a Thermostat/ClearWeeklySchedule command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Thermostat/Commands/ClearWeeklySchedule' -m  '{  }'

To receive a Thermostat/ClearWeeklySchedule generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Thermostat/GeneratedCommands/ClearWeeklySchedule'

\subsection thermostat_get_relay_status_log_cmd Thermostat/GetRelayStatusLog Command

MQTT Topic Pattern:

[PREFIX]/Thermostat/Commands/GetRelayStatusLog
[PREFIX]/Thermostat/GeneratedCommands/GetRelayStatusLog

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster GetRelayStatusLog Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
  ]
}

Example Mosquitto CLI Tool Usage

To send a Thermostat/GetRelayStatusLog command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Thermostat/Commands/GetRelayStatusLog' -m  '{  }'

To receive a Thermostat/GetRelayStatusLog generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Thermostat/GeneratedCommands/GetRelayStatusLog'

\subsection thermostat_write_attr_cmd Thermostat/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/Thermostat/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
    "HVACSystemTypeConfiguration": {
      "type": "ThermostatHVACSystemTypeConfiguration"
    },
    "LocalTemperatureCalibration": {
      "type": "integer"
    },
    "OccupiedCoolingSetpoint": {
      "type": "integer"
    },
    "OccupiedHeatingSetpoint": {
      "type": "integer"
    },
    "UnoccupiedCoolingSetpoint": {
      "type": "integer"
    },
    "UnoccupiedHeatingSetpoint": {
      "type": "integer"
    },
    "MinHeatSetpointLimit": {
      "type": "integer"
    },
    "MaxHeatSetpointLimit": {
      "type": "integer"
    },
    "MinCoolSetpointLimit": {
      "type": "integer"
    },
    "MaxCoolSetpointLimit": {
      "type": "integer"
    },
    "MinSetpointDeadBand": {
      "type": "integer"
    },
    "RemoteSensing": {
      "type": "ThermostatRemoteSensing"
    },
    "ControlSequenceOfOperation": {
      "type": "ThermostatControlSequenceOfOperation"
    },
    "SystemMode": {
      "type": "ThermostatSystemMode"
    },
    "TemperatureSetpointHold": {
      "type": "ThermostatTemperatureSetpointHold"
    },
    "TemperatureSetpointHoldDuration": {
      "type": "integer"
    },
    "ThermostatProgrammingOperationMode": {
      "type": "ThermostatThermostatProgrammingOperationMode"
    },
    "OccupiedSetback": {
      "type": "integer"
    },
    "UnoccupiedSetback": {
      "type": "integer"
    },
    "EmergencyHeatDelta": {
      "type": "integer"
    },
    "ACType": {
      "type": "ThermostatACType"
    },
    "ACCapacity": {
      "type": "integer"
    },
    "ACRefrigerantType": {
      "type": "ThermostatACRefrigerantType"
    },
    "ACCompressorType": {
      "type": "ThermostatACCompressorType"
    },
    "ACErrorCode": {
      "type": "ThermostatACErrorCode"
    },
    "ACLouverPosition": {
      "type": "ThermostatACLouverPosition"
    },
    "ACCapacityFormat": {
      "type": "ThermostatACCapacityFormat"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all Thermostat attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Thermostat/Commands/WriteAttributes' -m  '{ "HVACSystemTypeConfiguration": <HVAC_SYSTEM_TYPE_CONFIGURATION_VALUE> ,"LocalTemperatureCalibration": <LOCAL_TEMPERATURE_CALIBRATION_VALUE> ,"OccupiedCoolingSetpoint": <OCCUPIED_COOLING_SETPOINT_VALUE> ,"OccupiedHeatingSetpoint": <OCCUPIED_HEATING_SETPOINT_VALUE> ,"UnoccupiedCoolingSetpoint": <UNOCCUPIED_COOLING_SETPOINT_VALUE> ,"UnoccupiedHeatingSetpoint": <UNOCCUPIED_HEATING_SETPOINT_VALUE> ,"MinHeatSetpointLimit": <MIN_HEAT_SETPOINT_LIMIT_VALUE> ,"MaxHeatSetpointLimit": <MAX_HEAT_SETPOINT_LIMIT_VALUE> ,"MinCoolSetpointLimit": <MIN_COOL_SETPOINT_LIMIT_VALUE> ,"MaxCoolSetpointLimit": <MAX_COOL_SETPOINT_LIMIT_VALUE> ,"MinSetpointDeadBand": <MIN_SETPOINT_DEAD_BAND_VALUE> ,"RemoteSensing": <REMOTE_SENSING_VALUE> ,"ControlSequenceOfOperation": <CONTROL_SEQUENCE_OF_OPERATION_VALUE> ,"SystemMode": <SYSTEM_MODE_VALUE> ,"TemperatureSetpointHold": <TEMPERATURE_SETPOINT_HOLD_VALUE> ,"TemperatureSetpointHoldDuration": <TEMPERATURE_SETPOINT_HOLD_DURATION_VALUE> ,"ThermostatProgrammingOperationMode": <THERMOSTAT_PROGRAMMING_OPERATION_MODE_VALUE> ,"OccupiedSetback": <OCCUPIED_SETBACK_VALUE> ,"UnoccupiedSetback": <UNOCCUPIED_SETBACK_VALUE> ,"EmergencyHeatDelta": <EMERGENCY_HEAT_DELTA_VALUE> ,"ACType": <AC_TYPE_VALUE> ,"ACCapacity": <AC_CAPACITY_VALUE> ,"ACRefrigerantType": <AC_REFRIGERANT_TYPE_VALUE> ,"ACCompressorType": <AC_COMPRESSOR_TYPE_VALUE> ,"ACErrorCode": <AC_ERROR_CODE_VALUE> ,"ACLouverPosition": <AC_LOUVER_POSITION_VALUE> ,"ACCapacityFormat": <AC_CAPACITY_FORMAT_VALUE>  }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection thermostat_force_read_attr_cmd Thermostat/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/Thermostat/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "LocalTemperature",
          "OutdoorTemperature",
          "Occupancy",
          "AbsMinHeatSetpointLimit",
          "AbsMaxHeatSetpointLimit",
          "AbsMinCoolSetpointLimit",
          "AbsMaxCoolSetpointLimit",
          "PICoolingDemand",
          "PIHeatingDemand",
          "HVACSystemTypeConfiguration",
          "LocalTemperatureCalibration",
          "OccupiedCoolingSetpoint",
          "OccupiedHeatingSetpoint",
          "UnoccupiedCoolingSetpoint",
          "UnoccupiedHeatingSetpoint",
          "MinHeatSetpointLimit",
          "MaxHeatSetpointLimit",
          "MinCoolSetpointLimit",
          "MaxCoolSetpointLimit",
          "MinSetpointDeadBand",
          "RemoteSensing",
          "ControlSequenceOfOperation",
          "SystemMode",
          "AlarmMask",
          "ThermostatRunningMode",
          "StartOfWeek",
          "NumberOfWeeklyTransitions",
          "NumberOfDailyTransitions",
          "TemperatureSetpointHold",
          "TemperatureSetpointHoldDuration",
          "ThermostatProgrammingOperationMode",
          "ThermostatRunningState",
          "SetpointChangeSource",
          "SetpointChangeAmount",
          "SetpointChangeSourceTimestamp",
          "OccupiedSetback",
          "OccupiedSetbackMin",
          "OccupiedSetbackMax",
          "UnoccupiedSetback",
          "UnoccupiedSetbackMin",
          "UnoccupiedSetbackMax",
          "EmergencyHeatDelta",
          "ACType",
          "ACCapacity",
          "ACRefrigerantType",
          "ACCompressorType",
          "ACErrorCode",
          "ACLouverPosition",
          "ACCoilTemperature",
          "ACCapacityFormat"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all Thermostat attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Thermostat/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the Thermostat attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Thermostat/Commands/ForceReadAttributes' -m  '{ "value": ["LocalTemperature"] }'

\page fan_control FanControl Cluster The following commands and attributes are accepted as JSON payloads for the FanControl cluster.

\section fan_control_attrs FanControl Attributes The following attribute topics are used to retrieve the FanControl cluster state.

\subsection fan_control_attr_fan_mode FanControl/FanMode Attribute

MQTT Topic Pattern:

[PREFIX]/FanControl/Attributes/FanMode/Reported
[PREFIX]/FanControl/Attributes/FanMode/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "FanControl Cluster FanMode Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "FanControlFanMode"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for FanMode attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/FanControl/Attributes/FanMode/+'

# Example output

ucl/by-unid/<UNID>/ep0/FanControl/Attributes/FanMode/Desired { "value": <DESIRED_FAN_MODE>}
ucl/by-unid/<UNID>/ep0/FanControl/Attributes/FanMode/Reported { "value": <REPORTED_FAN_MODE>}

\subsection fan_control_attr_fan_mode_sequence FanControl/FanModeSequence Attribute

MQTT Topic Pattern:

[PREFIX]/FanControl/Attributes/FanModeSequence/Reported
[PREFIX]/FanControl/Attributes/FanModeSequence/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "FanControl Cluster FanModeSequence Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "FanControlFanModeSequence"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for FanModeSequence attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/FanControl/Attributes/FanModeSequence/+'

# Example output

ucl/by-unid/<UNID>/ep0/FanControl/Attributes/FanModeSequence/Desired { "value": <DESIRED_FAN_MODE_SEQUENCE>}
ucl/by-unid/<UNID>/ep0/FanControl/Attributes/FanModeSequence/Reported { "value": <REPORTED_FAN_MODE_SEQUENCE>}

\subsection fan_control_attr_cluster_revision FanControl/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/FanControl/Attributes/ClusterRevision/Reported
[PREFIX]/FanControl/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "FanControl Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/FanControl/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/FanControl/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/FanControl/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section fan_control_recv_cmd_support FanControl Command Support

MQTT Topic Pattern:

[PREFIX]/FanControl/SupportedCommands
[PREFIX]/FanControl/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "FanControl Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for FanControl cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/FanControl/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/FanControl/SupportedCommands { "value": [] }

To see supported generated commands for FanControl cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/FanControl/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/FanControl/SupportedGeneratedCommands { "value": [] }

\section fan_control_cmds FanControl Commands

\subsection fan_control_write_attr_cmd FanControl/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/FanControl/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "FanControl Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
    "FanMode": {
      "type": "FanControlFanMode"
    },
    "FanModeSequence": {
      "type": "FanControlFanModeSequence"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all FanControl attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/FanControl/Commands/WriteAttributes' -m  '{ "FanMode": <FAN_MODE_VALUE> ,"FanModeSequence": <FAN_MODE_SEQUENCE_VALUE>  }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection fan_control_force_read_attr_cmd FanControl/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/FanControl/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "FanControl Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "FanMode",
          "FanModeSequence"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all FanControl attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/FanControl/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the FanControl attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/FanControl/Commands/ForceReadAttributes' -m  '{ "value": ["FanMode"] }'

\page dehumidification_control DehumidificationControl Cluster The following commands and attributes are accepted as JSON payloads for the DehumidificationControl cluster.

\section dehumidification_control_attrs DehumidificationControl Attributes The following attribute topics are used to retrieve the DehumidificationControl cluster state.

\subsection dehumidification_control_attr_relative_humidity DehumidificationControl/RelativeHumidity Attribute

MQTT Topic Pattern:

[PREFIX]/DehumidificationControl/Attributes/RelativeHumidity/Reported
[PREFIX]/DehumidificationControl/Attributes/RelativeHumidity/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DehumidificationControl Cluster RelativeHumidity Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RelativeHumidity attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DehumidificationControl/Attributes/RelativeHumidity/+'

# Example output

ucl/by-unid/<UNID>/ep0/DehumidificationControl/Attributes/RelativeHumidity/Desired { "value": <DESIRED_RELATIVE_HUMIDITY>}
ucl/by-unid/<UNID>/ep0/DehumidificationControl/Attributes/RelativeHumidity/Reported { "value": <REPORTED_RELATIVE_HUMIDITY>}

\subsection dehumidification_control_attr_dehumidification_cooling DehumidificationControl/DehumidificationCooling Attribute

MQTT Topic Pattern:

[PREFIX]/DehumidificationControl/Attributes/DehumidificationCooling/Reported
[PREFIX]/DehumidificationControl/Attributes/DehumidificationCooling/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DehumidificationControl Cluster DehumidificationCooling Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DehumidificationCooling attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DehumidificationControl/Attributes/DehumidificationCooling/+'

# Example output

ucl/by-unid/<UNID>/ep0/DehumidificationControl/Attributes/DehumidificationCooling/Desired { "value": <DESIRED_DEHUMIDIFICATION_COOLING>}
ucl/by-unid/<UNID>/ep0/DehumidificationControl/Attributes/DehumidificationCooling/Reported { "value": <REPORTED_DEHUMIDIFICATION_COOLING>}

\subsection dehumidification_control_attr_rh_dehumidification_setpoint DehumidificationControl/RHDehumidificationSetpoint Attribute

MQTT Topic Pattern:

[PREFIX]/DehumidificationControl/Attributes/RHDehumidificationSetpoint/Reported
[PREFIX]/DehumidificationControl/Attributes/RHDehumidificationSetpoint/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DehumidificationControl Cluster RHDehumidificationSetpoint Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RHDehumidificationSetpoint attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DehumidificationControl/Attributes/RHDehumidificationSetpoint/+'

# Example output

ucl/by-unid/<UNID>/ep0/DehumidificationControl/Attributes/RHDehumidificationSetpoint/Desired { "value": <DESIRED_RH_DEHUMIDIFICATION_SETPOINT>}
ucl/by-unid/<UNID>/ep0/DehumidificationControl/Attributes/RHDehumidificationSetpoint/Reported { "value": <REPORTED_RH_DEHUMIDIFICATION_SETPOINT>}

\subsection dehumidification_control_attr_relative_humidity_mode DehumidificationControl/RelativeHumidityMode Attribute

MQTT Topic Pattern:

[PREFIX]/DehumidificationControl/Attributes/RelativeHumidityMode/Reported
[PREFIX]/DehumidificationControl/Attributes/RelativeHumidityMode/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DehumidificationControl Cluster RelativeHumidityMode Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "DehumidificationControlRelativeHumidityMode"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RelativeHumidityMode attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DehumidificationControl/Attributes/RelativeHumidityMode/+'

# Example output

ucl/by-unid/<UNID>/ep0/DehumidificationControl/Attributes/RelativeHumidityMode/Desired { "value": <DESIRED_RELATIVE_HUMIDITY_MODE>}
ucl/by-unid/<UNID>/ep0/DehumidificationControl/Attributes/RelativeHumidityMode/Reported { "value": <REPORTED_RELATIVE_HUMIDITY_MODE>}

\subsection dehumidification_control_attr_dehumidification_lockout DehumidificationControl/DehumidificationLockout Attribute

MQTT Topic Pattern:

[PREFIX]/DehumidificationControl/Attributes/DehumidificationLockout/Reported
[PREFIX]/DehumidificationControl/Attributes/DehumidificationLockout/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DehumidificationControl Cluster DehumidificationLockout Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "DehumidificationControlDehumidificationLockout"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DehumidificationLockout attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DehumidificationControl/Attributes/DehumidificationLockout/+'

# Example output

ucl/by-unid/<UNID>/ep0/DehumidificationControl/Attributes/DehumidificationLockout/Desired { "value": <DESIRED_DEHUMIDIFICATION_LOCKOUT>}
ucl/by-unid/<UNID>/ep0/DehumidificationControl/Attributes/DehumidificationLockout/Reported { "value": <REPORTED_DEHUMIDIFICATION_LOCKOUT>}

\subsection dehumidification_control_attr_dehumidification_hysteresis DehumidificationControl/DehumidificationHysteresis Attribute

MQTT Topic Pattern:

[PREFIX]/DehumidificationControl/Attributes/DehumidificationHysteresis/Reported
[PREFIX]/DehumidificationControl/Attributes/DehumidificationHysteresis/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DehumidificationControl Cluster DehumidificationHysteresis Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DehumidificationHysteresis attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DehumidificationControl/Attributes/DehumidificationHysteresis/+'

# Example output

ucl/by-unid/<UNID>/ep0/DehumidificationControl/Attributes/DehumidificationHysteresis/Desired { "value": <DESIRED_DEHUMIDIFICATION_HYSTERESIS>}
ucl/by-unid/<UNID>/ep0/DehumidificationControl/Attributes/DehumidificationHysteresis/Reported { "value": <REPORTED_DEHUMIDIFICATION_HYSTERESIS>}

\subsection dehumidification_control_attr_dehumidification_max_cool DehumidificationControl/DehumidificationMaxCool Attribute

MQTT Topic Pattern:

[PREFIX]/DehumidificationControl/Attributes/DehumidificationMaxCool/Reported
[PREFIX]/DehumidificationControl/Attributes/DehumidificationMaxCool/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DehumidificationControl Cluster DehumidificationMaxCool Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DehumidificationMaxCool attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DehumidificationControl/Attributes/DehumidificationMaxCool/+'

# Example output

ucl/by-unid/<UNID>/ep0/DehumidificationControl/Attributes/DehumidificationMaxCool/Desired { "value": <DESIRED_DEHUMIDIFICATION_MAX_COOL>}
ucl/by-unid/<UNID>/ep0/DehumidificationControl/Attributes/DehumidificationMaxCool/Reported { "value": <REPORTED_DEHUMIDIFICATION_MAX_COOL>}

\subsection dehumidification_control_attr_relative_humidity_display DehumidificationControl/RelativeHumidityDisplay Attribute

MQTT Topic Pattern:

[PREFIX]/DehumidificationControl/Attributes/RelativeHumidityDisplay/Reported
[PREFIX]/DehumidificationControl/Attributes/RelativeHumidityDisplay/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DehumidificationControl Cluster RelativeHumidityDisplay Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "DehumidificationControlRelativeHumidityDisplay"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RelativeHumidityDisplay attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DehumidificationControl/Attributes/RelativeHumidityDisplay/+'

# Example output

ucl/by-unid/<UNID>/ep0/DehumidificationControl/Attributes/RelativeHumidityDisplay/Desired { "value": <DESIRED_RELATIVE_HUMIDITY_DISPLAY>}
ucl/by-unid/<UNID>/ep0/DehumidificationControl/Attributes/RelativeHumidityDisplay/Reported { "value": <REPORTED_RELATIVE_HUMIDITY_DISPLAY>}

\subsection dehumidification_control_attr_cluster_revision DehumidificationControl/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/DehumidificationControl/Attributes/ClusterRevision/Reported
[PREFIX]/DehumidificationControl/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DehumidificationControl Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DehumidificationControl/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/DehumidificationControl/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/DehumidificationControl/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section dehumidification_control_recv_cmd_support DehumidificationControl Command Support

MQTT Topic Pattern:

[PREFIX]/DehumidificationControl/SupportedCommands
[PREFIX]/DehumidificationControl/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DehumidificationControl Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for DehumidificationControl cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DehumidificationControl/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/DehumidificationControl/SupportedCommands { "value": [] }

To see supported generated commands for DehumidificationControl cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DehumidificationControl/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/DehumidificationControl/SupportedGeneratedCommands { "value": [] }

\section dehumidification_control_cmds DehumidificationControl Commands

\subsection dehumidification_control_write_attr_cmd DehumidificationControl/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/DehumidificationControl/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DehumidificationControl Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
    "RHDehumidificationSetpoint": {
      "type": "integer"
    },
    "RelativeHumidityMode": {
      "type": "DehumidificationControlRelativeHumidityMode"
    },
    "DehumidificationLockout": {
      "type": "DehumidificationControlDehumidificationLockout"
    },
    "DehumidificationHysteresis": {
      "type": "integer"
    },
    "DehumidificationMaxCool": {
      "type": "integer"
    },
    "RelativeHumidityDisplay": {
      "type": "DehumidificationControlRelativeHumidityDisplay"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all DehumidificationControl attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DehumidificationControl/Commands/WriteAttributes' -m  '{ "RHDehumidificationSetpoint": <RH_DEHUMIDIFICATION_SETPOINT_VALUE> ,"RelativeHumidityMode": <RELATIVE_HUMIDITY_MODE_VALUE> ,"DehumidificationLockout": <DEHUMIDIFICATION_LOCKOUT_VALUE> ,"DehumidificationHysteresis": <DEHUMIDIFICATION_HYSTERESIS_VALUE> ,"DehumidificationMaxCool": <DEHUMIDIFICATION_MAX_COOL_VALUE> ,"RelativeHumidityDisplay": <RELATIVE_HUMIDITY_DISPLAY_VALUE>  }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection dehumidification_control_force_read_attr_cmd DehumidificationControl/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/DehumidificationControl/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DehumidificationControl Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "RelativeHumidity",
          "DehumidificationCooling",
          "RHDehumidificationSetpoint",
          "RelativeHumidityMode",
          "DehumidificationLockout",
          "DehumidificationHysteresis",
          "DehumidificationMaxCool",
          "RelativeHumidityDisplay"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all DehumidificationControl attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DehumidificationControl/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the DehumidificationControl attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DehumidificationControl/Commands/ForceReadAttributes' -m  '{ "value": ["RelativeHumidity"] }'

\page thermostat_user_interface_configuration ThermostatUserInterfaceConfiguration Cluster The following commands and attributes are accepted as JSON payloads for the ThermostatUserInterfaceConfiguration cluster.

\section thermostat_user_interface_configuration_attrs ThermostatUserInterfaceConfiguration Attributes The following attribute topics are used to retrieve the ThermostatUserInterfaceConfiguration cluster state.

\subsection thermostat_user_interface_configuration_attr_temperature_display_mode ThermostatUserInterfaceConfiguration/TemperatureDisplayMode Attribute

MQTT Topic Pattern:

[PREFIX]/ThermostatUserInterfaceConfiguration/Attributes/TemperatureDisplayMode/Reported
[PREFIX]/ThermostatUserInterfaceConfiguration/Attributes/TemperatureDisplayMode/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ThermostatUserInterfaceConfiguration Cluster TemperatureDisplayMode Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ThermostatUserInterfaceConfigurationTemperatureDisplayMode"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for TemperatureDisplayMode attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ThermostatUserInterfaceConfiguration/Attributes/TemperatureDisplayMode/+'

# Example output

ucl/by-unid/<UNID>/ep0/ThermostatUserInterfaceConfiguration/Attributes/TemperatureDisplayMode/Desired { "value": <DESIRED_TEMPERATURE_DISPLAY_MODE>}
ucl/by-unid/<UNID>/ep0/ThermostatUserInterfaceConfiguration/Attributes/TemperatureDisplayMode/Reported { "value": <REPORTED_TEMPERATURE_DISPLAY_MODE>}

\subsection thermostat_user_interface_configuration_attr_keypad_lockout ThermostatUserInterfaceConfiguration/KeypadLockout Attribute

MQTT Topic Pattern:

[PREFIX]/ThermostatUserInterfaceConfiguration/Attributes/KeypadLockout/Reported
[PREFIX]/ThermostatUserInterfaceConfiguration/Attributes/KeypadLockout/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ThermostatUserInterfaceConfiguration Cluster KeypadLockout Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ThermostatUserInterfaceConfigurationKeypadLockout"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for KeypadLockout attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ThermostatUserInterfaceConfiguration/Attributes/KeypadLockout/+'

# Example output

ucl/by-unid/<UNID>/ep0/ThermostatUserInterfaceConfiguration/Attributes/KeypadLockout/Desired { "value": <DESIRED_KEYPAD_LOCKOUT>}
ucl/by-unid/<UNID>/ep0/ThermostatUserInterfaceConfiguration/Attributes/KeypadLockout/Reported { "value": <REPORTED_KEYPAD_LOCKOUT>}

\subsection thermostat_user_interface_configuration_attr_schedule_programming_visibility ThermostatUserInterfaceConfiguration/ScheduleProgrammingVisibility Attribute

MQTT Topic Pattern:

[PREFIX]/ThermostatUserInterfaceConfiguration/Attributes/ScheduleProgrammingVisibility/Reported
[PREFIX]/ThermostatUserInterfaceConfiguration/Attributes/ScheduleProgrammingVisibility/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ThermostatUserInterfaceConfiguration Cluster ScheduleProgrammingVisibility Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ThermostatUserInterfaceConfigurationScheduleProgrammingVisibility"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ScheduleProgrammingVisibility attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ThermostatUserInterfaceConfiguration/Attributes/ScheduleProgrammingVisibility/+'

# Example output

ucl/by-unid/<UNID>/ep0/ThermostatUserInterfaceConfiguration/Attributes/ScheduleProgrammingVisibility/Desired { "value": <DESIRED_SCHEDULE_PROGRAMMING_VISIBILITY>}
ucl/by-unid/<UNID>/ep0/ThermostatUserInterfaceConfiguration/Attributes/ScheduleProgrammingVisibility/Reported { "value": <REPORTED_SCHEDULE_PROGRAMMING_VISIBILITY>}

\subsection thermostat_user_interface_configuration_attr_cluster_revision ThermostatUserInterfaceConfiguration/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/ThermostatUserInterfaceConfiguration/Attributes/ClusterRevision/Reported
[PREFIX]/ThermostatUserInterfaceConfiguration/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ThermostatUserInterfaceConfiguration Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ThermostatUserInterfaceConfiguration/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/ThermostatUserInterfaceConfiguration/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/ThermostatUserInterfaceConfiguration/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section thermostat_user_interface_configuration_recv_cmd_support ThermostatUserInterfaceConfiguration Command Support

MQTT Topic Pattern:

[PREFIX]/ThermostatUserInterfaceConfiguration/SupportedCommands
[PREFIX]/ThermostatUserInterfaceConfiguration/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ThermostatUserInterfaceConfiguration Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for ThermostatUserInterfaceConfiguration cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ThermostatUserInterfaceConfiguration/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/ThermostatUserInterfaceConfiguration/SupportedCommands { "value": [] }

To see supported generated commands for ThermostatUserInterfaceConfiguration cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ThermostatUserInterfaceConfiguration/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/ThermostatUserInterfaceConfiguration/SupportedGeneratedCommands { "value": [] }

\section thermostat_user_interface_configuration_cmds ThermostatUserInterfaceConfiguration Commands

\subsection thermostat_user_interface_configuration_write_attr_cmd ThermostatUserInterfaceConfiguration/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/ThermostatUserInterfaceConfiguration/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ThermostatUserInterfaceConfiguration Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
    "TemperatureDisplayMode": {
      "type": "ThermostatUserInterfaceConfigurationTemperatureDisplayMode"
    },
    "KeypadLockout": {
      "type": "ThermostatUserInterfaceConfigurationKeypadLockout"
    },
    "ScheduleProgrammingVisibility": {
      "type": "ThermostatUserInterfaceConfigurationScheduleProgrammingVisibility"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all ThermostatUserInterfaceConfiguration attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ThermostatUserInterfaceConfiguration/Commands/WriteAttributes' -m  '{ "TemperatureDisplayMode": <TEMPERATURE_DISPLAY_MODE_VALUE> ,"KeypadLockout": <KEYPAD_LOCKOUT_VALUE> ,"ScheduleProgrammingVisibility": <SCHEDULE_PROGRAMMING_VISIBILITY_VALUE>  }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection thermostat_user_interface_configuration_force_read_attr_cmd ThermostatUserInterfaceConfiguration/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/ThermostatUserInterfaceConfiguration/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ThermostatUserInterfaceConfiguration Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "TemperatureDisplayMode",
          "KeypadLockout",
          "ScheduleProgrammingVisibility"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all ThermostatUserInterfaceConfiguration attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ThermostatUserInterfaceConfiguration/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the ThermostatUserInterfaceConfiguration attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ThermostatUserInterfaceConfiguration/Commands/ForceReadAttributes' -m  '{ "value": ["TemperatureDisplayMode"] }'

\page color_control ColorControl Cluster The following commands and attributes are accepted as JSON payloads for the ColorControl cluster.

\section color_control_attrs ColorControl Attributes The following attribute topics are used to retrieve the ColorControl cluster state.

\subsection color_control_attr_current_hue ColorControl/CurrentHue Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/CurrentHue/Reported
[PREFIX]/ColorControl/Attributes/CurrentHue/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster CurrentHue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CurrentHue attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/CurrentHue/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/CurrentHue/Desired { "value": <DESIRED_CURRENT_HUE>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/CurrentHue/Reported { "value": <REPORTED_CURRENT_HUE>}

\subsection color_control_attr_current_saturation ColorControl/CurrentSaturation Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/CurrentSaturation/Reported
[PREFIX]/ColorControl/Attributes/CurrentSaturation/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster CurrentSaturation Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CurrentSaturation attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/CurrentSaturation/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/CurrentSaturation/Desired { "value": <DESIRED_CURRENT_SATURATION>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/CurrentSaturation/Reported { "value": <REPORTED_CURRENT_SATURATION>}

\subsection color_control_attr_remaining_time ColorControl/RemainingTime Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/RemainingTime/Reported
[PREFIX]/ColorControl/Attributes/RemainingTime/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster RemainingTime Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RemainingTime attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/RemainingTime/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/RemainingTime/Desired { "value": <DESIRED_REMAINING_TIME>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/RemainingTime/Reported { "value": <REPORTED_REMAINING_TIME>}

\subsection color_control_attr_currentx ColorControl/CurrentX Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/CurrentX/Reported
[PREFIX]/ColorControl/Attributes/CurrentX/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster CurrentX Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CurrentX attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/CurrentX/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/CurrentX/Desired { "value": <DESIRED_CURRENTX>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/CurrentX/Reported { "value": <REPORTED_CURRENTX>}

\subsection color_control_attr_currenty ColorControl/CurrentY Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/CurrentY/Reported
[PREFIX]/ColorControl/Attributes/CurrentY/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster CurrentY Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CurrentY attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/CurrentY/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/CurrentY/Desired { "value": <DESIRED_CURRENTY>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/CurrentY/Reported { "value": <REPORTED_CURRENTY>}

\subsection color_control_attr_drift_compensation ColorControl/DriftCompensation Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/DriftCompensation/Reported
[PREFIX]/ColorControl/Attributes/DriftCompensation/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster DriftCompensation Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ColorControlDriftCompensation"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DriftCompensation attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/DriftCompensation/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/DriftCompensation/Desired { "value": <DESIRED_DRIFT_COMPENSATION>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/DriftCompensation/Reported { "value": <REPORTED_DRIFT_COMPENSATION>}

\subsection color_control_attr_compensation_text ColorControl/CompensationText Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/CompensationText/Reported
[PREFIX]/ColorControl/Attributes/CompensationText/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster CompensationText Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CompensationText attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/CompensationText/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/CompensationText/Desired { "value": <DESIRED_COMPENSATION_TEXT>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/CompensationText/Reported { "value": <REPORTED_COMPENSATION_TEXT>}

\subsection color_control_attr_color_temperature_mireds ColorControl/ColorTemperatureMireds Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/ColorTemperatureMireds/Reported
[PREFIX]/ColorControl/Attributes/ColorTemperatureMireds/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster ColorTemperatureMireds Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ColorTemperatureMireds attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/ColorTemperatureMireds/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorTemperatureMireds/Desired { "value": <DESIRED_COLOR_TEMPERATURE_MIREDS>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorTemperatureMireds/Reported { "value": <REPORTED_COLOR_TEMPERATURE_MIREDS>}

\subsection color_control_attr_color_mode ColorControl/ColorMode Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/ColorMode/Reported
[PREFIX]/ColorControl/Attributes/ColorMode/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster ColorMode Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ColorControlColorMode"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ColorMode attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/ColorMode/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorMode/Desired { "value": <DESIRED_COLOR_MODE>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorMode/Reported { "value": <REPORTED_COLOR_MODE>}

\subsection color_control_attr_options ColorControl/Options Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/Options/Reported
[PREFIX]/ColorControl/Attributes/Options/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster Options Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "CCColorOptions"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Options attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/Options/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Options/Desired { "value": <DESIRED_OPTIONS>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Options/Reported { "value": <REPORTED_OPTIONS>}

\subsection color_control_attr_number_of_primaries ColorControl/NumberOfPrimaries Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/NumberOfPrimaries/Reported
[PREFIX]/ColorControl/Attributes/NumberOfPrimaries/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster NumberOfPrimaries Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for NumberOfPrimaries attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/NumberOfPrimaries/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/NumberOfPrimaries/Desired { "value": <DESIRED_NUMBER_OF_PRIMARIES>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/NumberOfPrimaries/Reported { "value": <REPORTED_NUMBER_OF_PRIMARIES>}

\subsection color_control_attr_primary1x ColorControl/Primary1X Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/Primary1X/Reported
[PREFIX]/ColorControl/Attributes/Primary1X/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster Primary1X Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Primary1X attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/Primary1X/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary1X/Desired { "value": <DESIRED_PRIMARY1X>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary1X/Reported { "value": <REPORTED_PRIMARY1X>}

\subsection color_control_attr_primary1y ColorControl/Primary1Y Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/Primary1Y/Reported
[PREFIX]/ColorControl/Attributes/Primary1Y/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster Primary1Y Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Primary1Y attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/Primary1Y/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary1Y/Desired { "value": <DESIRED_PRIMARY1Y>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary1Y/Reported { "value": <REPORTED_PRIMARY1Y>}

\subsection color_control_attr_primary1_intensity ColorControl/Primary1Intensity Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/Primary1Intensity/Reported
[PREFIX]/ColorControl/Attributes/Primary1Intensity/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster Primary1Intensity Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Primary1Intensity attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/Primary1Intensity/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary1Intensity/Desired { "value": <DESIRED_PRIMARY1_INTENSITY>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary1Intensity/Reported { "value": <REPORTED_PRIMARY1_INTENSITY>}

\subsection color_control_attr_primary2x ColorControl/Primary2X Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/Primary2X/Reported
[PREFIX]/ColorControl/Attributes/Primary2X/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster Primary2X Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Primary2X attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/Primary2X/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary2X/Desired { "value": <DESIRED_PRIMARY2X>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary2X/Reported { "value": <REPORTED_PRIMARY2X>}

\subsection color_control_attr_primary2y ColorControl/Primary2Y Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/Primary2Y/Reported
[PREFIX]/ColorControl/Attributes/Primary2Y/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster Primary2Y Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Primary2Y attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/Primary2Y/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary2Y/Desired { "value": <DESIRED_PRIMARY2Y>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary2Y/Reported { "value": <REPORTED_PRIMARY2Y>}

\subsection color_control_attr_primary2_intensity ColorControl/Primary2Intensity Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/Primary2Intensity/Reported
[PREFIX]/ColorControl/Attributes/Primary2Intensity/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster Primary2Intensity Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Primary2Intensity attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/Primary2Intensity/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary2Intensity/Desired { "value": <DESIRED_PRIMARY2_INTENSITY>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary2Intensity/Reported { "value": <REPORTED_PRIMARY2_INTENSITY>}

\subsection color_control_attr_primary3x ColorControl/Primary3X Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/Primary3X/Reported
[PREFIX]/ColorControl/Attributes/Primary3X/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster Primary3X Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Primary3X attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/Primary3X/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary3X/Desired { "value": <DESIRED_PRIMARY3X>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary3X/Reported { "value": <REPORTED_PRIMARY3X>}

\subsection color_control_attr_primary3y ColorControl/Primary3Y Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/Primary3Y/Reported
[PREFIX]/ColorControl/Attributes/Primary3Y/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster Primary3Y Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Primary3Y attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/Primary3Y/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary3Y/Desired { "value": <DESIRED_PRIMARY3Y>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary3Y/Reported { "value": <REPORTED_PRIMARY3Y>}

\subsection color_control_attr_primary3_intensity ColorControl/Primary3Intensity Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/Primary3Intensity/Reported
[PREFIX]/ColorControl/Attributes/Primary3Intensity/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster Primary3Intensity Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Primary3Intensity attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/Primary3Intensity/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary3Intensity/Desired { "value": <DESIRED_PRIMARY3_INTENSITY>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary3Intensity/Reported { "value": <REPORTED_PRIMARY3_INTENSITY>}

\subsection color_control_attr_primary4x ColorControl/Primary4X Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/Primary4X/Reported
[PREFIX]/ColorControl/Attributes/Primary4X/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster Primary4X Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Primary4X attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/Primary4X/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary4X/Desired { "value": <DESIRED_PRIMARY4X>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary4X/Reported { "value": <REPORTED_PRIMARY4X>}

\subsection color_control_attr_primary4y ColorControl/Primary4Y Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/Primary4Y/Reported
[PREFIX]/ColorControl/Attributes/Primary4Y/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster Primary4Y Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Primary4Y attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/Primary4Y/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary4Y/Desired { "value": <DESIRED_PRIMARY4Y>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary4Y/Reported { "value": <REPORTED_PRIMARY4Y>}

\subsection color_control_attr_primary4_intensity ColorControl/Primary4Intensity Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/Primary4Intensity/Reported
[PREFIX]/ColorControl/Attributes/Primary4Intensity/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster Primary4Intensity Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Primary4Intensity attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/Primary4Intensity/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary4Intensity/Desired { "value": <DESIRED_PRIMARY4_INTENSITY>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary4Intensity/Reported { "value": <REPORTED_PRIMARY4_INTENSITY>}

\subsection color_control_attr_primary5x ColorControl/Primary5X Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/Primary5X/Reported
[PREFIX]/ColorControl/Attributes/Primary5X/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster Primary5X Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Primary5X attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/Primary5X/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary5X/Desired { "value": <DESIRED_PRIMARY5X>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary5X/Reported { "value": <REPORTED_PRIMARY5X>}

\subsection color_control_attr_primary5y ColorControl/Primary5Y Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/Primary5Y/Reported
[PREFIX]/ColorControl/Attributes/Primary5Y/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster Primary5Y Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Primary5Y attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/Primary5Y/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary5Y/Desired { "value": <DESIRED_PRIMARY5Y>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary5Y/Reported { "value": <REPORTED_PRIMARY5Y>}

\subsection color_control_attr_primary5_intensity ColorControl/Primary5Intensity Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/Primary5Intensity/Reported
[PREFIX]/ColorControl/Attributes/Primary5Intensity/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster Primary5Intensity Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Primary5Intensity attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/Primary5Intensity/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary5Intensity/Desired { "value": <DESIRED_PRIMARY5_INTENSITY>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary5Intensity/Reported { "value": <REPORTED_PRIMARY5_INTENSITY>}

\subsection color_control_attr_primary6x ColorControl/Primary6X Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/Primary6X/Reported
[PREFIX]/ColorControl/Attributes/Primary6X/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster Primary6X Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Primary6X attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/Primary6X/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary6X/Desired { "value": <DESIRED_PRIMARY6X>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary6X/Reported { "value": <REPORTED_PRIMARY6X>}

\subsection color_control_attr_primary6y ColorControl/Primary6Y Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/Primary6Y/Reported
[PREFIX]/ColorControl/Attributes/Primary6Y/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster Primary6Y Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Primary6Y attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/Primary6Y/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary6Y/Desired { "value": <DESIRED_PRIMARY6Y>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary6Y/Reported { "value": <REPORTED_PRIMARY6Y>}

\subsection color_control_attr_primary6_intensity ColorControl/Primary6Intensity Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/Primary6Intensity/Reported
[PREFIX]/ColorControl/Attributes/Primary6Intensity/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster Primary6Intensity Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Primary6Intensity attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/Primary6Intensity/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary6Intensity/Desired { "value": <DESIRED_PRIMARY6_INTENSITY>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary6Intensity/Reported { "value": <REPORTED_PRIMARY6_INTENSITY>}

\subsection color_control_attr_white_pointx ColorControl/WhitePointX Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/WhitePointX/Reported
[PREFIX]/ColorControl/Attributes/WhitePointX/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster WhitePointX Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for WhitePointX attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/WhitePointX/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/WhitePointX/Desired { "value": <DESIRED_WHITE_POINTX>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/WhitePointX/Reported { "value": <REPORTED_WHITE_POINTX>}

\subsection color_control_attr_white_pointy ColorControl/WhitePointY Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/WhitePointY/Reported
[PREFIX]/ColorControl/Attributes/WhitePointY/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster WhitePointY Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for WhitePointY attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/WhitePointY/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/WhitePointY/Desired { "value": <DESIRED_WHITE_POINTY>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/WhitePointY/Reported { "value": <REPORTED_WHITE_POINTY>}

\subsection color_control_attr_color_pointrx ColorControl/ColorPointRX Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/ColorPointRX/Reported
[PREFIX]/ColorControl/Attributes/ColorPointRX/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster ColorPointRX Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ColorPointRX attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/ColorPointRX/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorPointRX/Desired { "value": <DESIRED_COLOR_POINTRX>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorPointRX/Reported { "value": <REPORTED_COLOR_POINTRX>}

\subsection color_control_attr_color_pointry ColorControl/ColorPointRY Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/ColorPointRY/Reported
[PREFIX]/ColorControl/Attributes/ColorPointRY/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster ColorPointRY Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ColorPointRY attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/ColorPointRY/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorPointRY/Desired { "value": <DESIRED_COLOR_POINTRY>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorPointRY/Reported { "value": <REPORTED_COLOR_POINTRY>}

\subsection color_control_attr_color_pointr_intensity ColorControl/ColorPointRIntensity Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/ColorPointRIntensity/Reported
[PREFIX]/ColorControl/Attributes/ColorPointRIntensity/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster ColorPointRIntensity Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ColorPointRIntensity attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/ColorPointRIntensity/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorPointRIntensity/Desired { "value": <DESIRED_COLOR_POINTR_INTENSITY>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorPointRIntensity/Reported { "value": <REPORTED_COLOR_POINTR_INTENSITY>}

\subsection color_control_attr_color_pointgx ColorControl/ColorPointGX Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/ColorPointGX/Reported
[PREFIX]/ColorControl/Attributes/ColorPointGX/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster ColorPointGX Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ColorPointGX attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/ColorPointGX/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorPointGX/Desired { "value": <DESIRED_COLOR_POINTGX>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorPointGX/Reported { "value": <REPORTED_COLOR_POINTGX>}

\subsection color_control_attr_color_pointgy ColorControl/ColorPointGY Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/ColorPointGY/Reported
[PREFIX]/ColorControl/Attributes/ColorPointGY/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster ColorPointGY Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ColorPointGY attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/ColorPointGY/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorPointGY/Desired { "value": <DESIRED_COLOR_POINTGY>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorPointGY/Reported { "value": <REPORTED_COLOR_POINTGY>}

\subsection color_control_attr_color_pointg_intensity ColorControl/ColorPointGIntensity Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/ColorPointGIntensity/Reported
[PREFIX]/ColorControl/Attributes/ColorPointGIntensity/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster ColorPointGIntensity Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ColorPointGIntensity attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/ColorPointGIntensity/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorPointGIntensity/Desired { "value": <DESIRED_COLOR_POINTG_INTENSITY>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorPointGIntensity/Reported { "value": <REPORTED_COLOR_POINTG_INTENSITY>}

\subsection color_control_attr_color_pointbx ColorControl/ColorPointBX Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/ColorPointBX/Reported
[PREFIX]/ColorControl/Attributes/ColorPointBX/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster ColorPointBX Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ColorPointBX attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/ColorPointBX/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorPointBX/Desired { "value": <DESIRED_COLOR_POINTBX>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorPointBX/Reported { "value": <REPORTED_COLOR_POINTBX>}

\subsection color_control_attr_color_pointby ColorControl/ColorPointBY Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/ColorPointBY/Reported
[PREFIX]/ColorControl/Attributes/ColorPointBY/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster ColorPointBY Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ColorPointBY attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/ColorPointBY/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorPointBY/Desired { "value": <DESIRED_COLOR_POINTBY>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorPointBY/Reported { "value": <REPORTED_COLOR_POINTBY>}

\subsection color_control_attr_color_pointb_intensity ColorControl/ColorPointBIntensity Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/ColorPointBIntensity/Reported
[PREFIX]/ColorControl/Attributes/ColorPointBIntensity/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster ColorPointBIntensity Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ColorPointBIntensity attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/ColorPointBIntensity/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorPointBIntensity/Desired { "value": <DESIRED_COLOR_POINTB_INTENSITY>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorPointBIntensity/Reported { "value": <REPORTED_COLOR_POINTB_INTENSITY>}

\subsection color_control_attr_enhanced_current_hue ColorControl/EnhancedCurrentHue Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/EnhancedCurrentHue/Reported
[PREFIX]/ColorControl/Attributes/EnhancedCurrentHue/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster EnhancedCurrentHue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for EnhancedCurrentHue attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/EnhancedCurrentHue/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/EnhancedCurrentHue/Desired { "value": <DESIRED_ENHANCED_CURRENT_HUE>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/EnhancedCurrentHue/Reported { "value": <REPORTED_ENHANCED_CURRENT_HUE>}

\subsection color_control_attr_enhanced_color_mode ColorControl/EnhancedColorMode Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/EnhancedColorMode/Reported
[PREFIX]/ColorControl/Attributes/EnhancedColorMode/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster EnhancedColorMode Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ColorControlEnhancedColorMode"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for EnhancedColorMode attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/EnhancedColorMode/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/EnhancedColorMode/Desired { "value": <DESIRED_ENHANCED_COLOR_MODE>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/EnhancedColorMode/Reported { "value": <REPORTED_ENHANCED_COLOR_MODE>}

\subsection color_control_attr_color_loop_active ColorControl/ColorLoopActive Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/ColorLoopActive/Reported
[PREFIX]/ColorControl/Attributes/ColorLoopActive/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster ColorLoopActive Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ColorLoopActive attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/ColorLoopActive/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorLoopActive/Desired { "value": <DESIRED_COLOR_LOOP_ACTIVE>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorLoopActive/Reported { "value": <REPORTED_COLOR_LOOP_ACTIVE>}

\subsection color_control_attr_color_loop_direction ColorControl/ColorLoopDirection Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/ColorLoopDirection/Reported
[PREFIX]/ColorControl/Attributes/ColorLoopDirection/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster ColorLoopDirection Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "CCColorLoopDirection"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ColorLoopDirection attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/ColorLoopDirection/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorLoopDirection/Desired { "value": <DESIRED_COLOR_LOOP_DIRECTION>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorLoopDirection/Reported { "value": <REPORTED_COLOR_LOOP_DIRECTION>}

\subsection color_control_attr_color_loop_time ColorControl/ColorLoopTime Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/ColorLoopTime/Reported
[PREFIX]/ColorControl/Attributes/ColorLoopTime/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster ColorLoopTime Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ColorLoopTime attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/ColorLoopTime/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorLoopTime/Desired { "value": <DESIRED_COLOR_LOOP_TIME>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorLoopTime/Reported { "value": <REPORTED_COLOR_LOOP_TIME>}

\subsection color_control_attr_color_loop_start_enhanced_hue ColorControl/ColorLoopStartEnhancedHue Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/ColorLoopStartEnhancedHue/Reported
[PREFIX]/ColorControl/Attributes/ColorLoopStartEnhancedHue/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster ColorLoopStartEnhancedHue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ColorLoopStartEnhancedHue attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/ColorLoopStartEnhancedHue/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorLoopStartEnhancedHue/Desired { "value": <DESIRED_COLOR_LOOP_START_ENHANCED_HUE>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorLoopStartEnhancedHue/Reported { "value": <REPORTED_COLOR_LOOP_START_ENHANCED_HUE>}

\subsection color_control_attr_color_loop_stored_enhanced_hue ColorControl/ColorLoopStoredEnhancedHue Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/ColorLoopStoredEnhancedHue/Reported
[PREFIX]/ColorControl/Attributes/ColorLoopStoredEnhancedHue/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster ColorLoopStoredEnhancedHue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ColorLoopStoredEnhancedHue attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/ColorLoopStoredEnhancedHue/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorLoopStoredEnhancedHue/Desired { "value": <DESIRED_COLOR_LOOP_STORED_ENHANCED_HUE>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorLoopStoredEnhancedHue/Reported { "value": <REPORTED_COLOR_LOOP_STORED_ENHANCED_HUE>}

\subsection color_control_attr_color_capabilities ColorControl/ColorCapabilities Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/ColorCapabilities/Reported
[PREFIX]/ColorControl/Attributes/ColorCapabilities/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster ColorCapabilities Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ColorControlColorCapabilities"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ColorCapabilities attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/ColorCapabilities/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorCapabilities/Desired { "value": <DESIRED_COLOR_CAPABILITIES>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorCapabilities/Reported { "value": <REPORTED_COLOR_CAPABILITIES>}

\subsection color_control_attr_color_temp_physical_min_mireds ColorControl/ColorTempPhysicalMinMireds Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/ColorTempPhysicalMinMireds/Reported
[PREFIX]/ColorControl/Attributes/ColorTempPhysicalMinMireds/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster ColorTempPhysicalMinMireds Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ColorTempPhysicalMinMireds attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/ColorTempPhysicalMinMireds/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorTempPhysicalMinMireds/Desired { "value": <DESIRED_COLOR_TEMP_PHYSICAL_MIN_MIREDS>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorTempPhysicalMinMireds/Reported { "value": <REPORTED_COLOR_TEMP_PHYSICAL_MIN_MIREDS>}

\subsection color_control_attr_color_temp_physical_max_mireds ColorControl/ColorTempPhysicalMaxMireds Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/ColorTempPhysicalMaxMireds/Reported
[PREFIX]/ColorControl/Attributes/ColorTempPhysicalMaxMireds/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster ColorTempPhysicalMaxMireds Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ColorTempPhysicalMaxMireds attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/ColorTempPhysicalMaxMireds/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorTempPhysicalMaxMireds/Desired { "value": <DESIRED_COLOR_TEMP_PHYSICAL_MAX_MIREDS>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorTempPhysicalMaxMireds/Reported { "value": <REPORTED_COLOR_TEMP_PHYSICAL_MAX_MIREDS>}

\subsection color_control_attr_couple_color_temp_to_level_min_mireds ColorControl/CoupleColorTempToLevelMinMireds Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/CoupleColorTempToLevelMinMireds/Reported
[PREFIX]/ColorControl/Attributes/CoupleColorTempToLevelMinMireds/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster CoupleColorTempToLevelMinMireds Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CoupleColorTempToLevelMinMireds attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/CoupleColorTempToLevelMinMireds/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/CoupleColorTempToLevelMinMireds/Desired { "value": <DESIRED_COUPLE_COLOR_TEMP_TO_LEVEL_MIN_MIREDS>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/CoupleColorTempToLevelMinMireds/Reported { "value": <REPORTED_COUPLE_COLOR_TEMP_TO_LEVEL_MIN_MIREDS>}

\subsection color_control_attr_start_up_color_temperature_mireds ColorControl/StartUpColorTemperatureMireds Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/StartUpColorTemperatureMireds/Reported
[PREFIX]/ColorControl/Attributes/StartUpColorTemperatureMireds/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster StartUpColorTemperatureMireds Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for StartUpColorTemperatureMireds attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/StartUpColorTemperatureMireds/+'

# Example output

ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/StartUpColorTemperatureMireds/Desired { "value": <DESIRED_START_UP_COLOR_TEMPERATURE_MIREDS>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/StartUpColorTemperatureMireds/Reported { "value": <REPORTED_START_UP_COLOR_TEMPERATURE_MIREDS>}

\subsection color_control_attr_cluster_revision ColorControl/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/ClusterRevision/Reported
[PREFIX]/ColorControl/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/ColorControl/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/ColorControl/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section color_control_recv_cmd_support ColorControl Command Support

MQTT Topic Pattern:

[PREFIX]/ColorControl/SupportedCommands
[PREFIX]/ColorControl/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
              "MoveToHue",
              "MoveHue",
              "StepHue",
              "MoveToSaturation",
              "MoveSaturation",
              "StepSaturation",
              "MoveToHueAndSaturation",
              "MoveToColor",
              "MoveColor",
              "StepColor",
              "MoveToColorTemperature",
              "EnhancedMoveToHue",
              "EnhancedMoveHue",
              "EnhancedStepHue",
              "EnhancedMoveToHueAndSaturation",
              "ColorLoopSet",
              "StopMoveStep",
              "MoveColorTemperature",
              "StepColorTemperature",
              "WriteAttributes",
              "ForceReadAttributes"
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for ColorControl cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/ColorControl/SupportedCommands { "value": ["MoveToHue","MoveHue","StepHue","MoveToSaturation","MoveSaturation","StepSaturation","MoveToHueAndSaturation","MoveToColor","MoveColor","StepColor","MoveToColorTemperature","EnhancedMoveToHue","EnhancedMoveHue","EnhancedStepHue","EnhancedMoveToHueAndSaturation","ColorLoopSet","StopMoveStep","MoveColorTemperature","StepColorTemperature","WriteAttributes", "ForceReadAttributes"] }

To see supported generated commands for ColorControl cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/ColorControl/SupportedGeneratedCommands { "value": [] }

\section color_control_cmds ColorControl Commands

\subsection color_control_move_to_hue_cmd ColorControl/MoveToHue Command

MQTT Topic Pattern:

[PREFIX]/ColorControl/Commands/MoveToHue
[PREFIX]/ColorControl/GeneratedCommands/MoveToHue

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster MoveToHue Command Properties",
  "type": "object",
  "properties": {
    "Hue": {
      "type": "integer"
    },
    "Direction": {
      "type": "CCDirection"
    },
    "TransitionTime": {
      "type": "integer"
    },
    "OptionsMask": {
      "type": "CCColorOptions"
    },
    "OptionsOverride": {
      "type": "CCColorOptions"
    }
  },
  "required": [
    "Hue",
    "Direction",
    "TransitionTime",
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ColorControl/MoveToHue command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/Commands/MoveToHue' -m  '{ "Hue": <HUE_VALUE>,"Direction": <DIRECTION_VALUE>,"TransitionTime": <TRANSITION_TIME_VALUE>,"OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a ColorControl/MoveToHue generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/GeneratedCommands/MoveToHue'

\subsection color_control_move_hue_cmd ColorControl/MoveHue Command

MQTT Topic Pattern:

[PREFIX]/ColorControl/Commands/MoveHue
[PREFIX]/ColorControl/GeneratedCommands/MoveHue

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster MoveHue Command Properties",
  "type": "object",
  "properties": {
    "MoveMode": {
      "type": "CCMoveMode"
    },
    "Rate": {
      "type": "integer"
    },
    "OptionsMask": {
      "type": "CCColorOptions"
    },
    "OptionsOverride": {
      "type": "CCColorOptions"
    }
  },
  "required": [
    "MoveMode",
    "Rate",
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ColorControl/MoveHue command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/Commands/MoveHue' -m  '{ "MoveMode": <MOVE_MODE_VALUE>,"Rate": <RATE_VALUE>,"OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a ColorControl/MoveHue generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/GeneratedCommands/MoveHue'

\subsection color_control_step_hue_cmd ColorControl/StepHue Command

MQTT Topic Pattern:

[PREFIX]/ColorControl/Commands/StepHue
[PREFIX]/ColorControl/GeneratedCommands/StepHue

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster StepHue Command Properties",
  "type": "object",
  "properties": {
    "StepMode": {
      "type": "CCStepMode"
    },
    "StepSize": {
      "type": "integer"
    },
    "TransitionTime": {
      "type": "integer"
    },
    "OptionsMask": {
      "type": "CCColorOptions"
    },
    "OptionsOverride": {
      "type": "CCColorOptions"
    }
  },
  "required": [
    "StepMode",
    "StepSize",
    "TransitionTime",
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ColorControl/StepHue command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/Commands/StepHue' -m  '{ "StepMode": <STEP_MODE_VALUE>,"StepSize": <STEP_SIZE_VALUE>,"TransitionTime": <TRANSITION_TIME_VALUE>,"OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a ColorControl/StepHue generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/GeneratedCommands/StepHue'

\subsection color_control_move_to_saturation_cmd ColorControl/MoveToSaturation Command

MQTT Topic Pattern:

[PREFIX]/ColorControl/Commands/MoveToSaturation
[PREFIX]/ColorControl/GeneratedCommands/MoveToSaturation

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster MoveToSaturation Command Properties",
  "type": "object",
  "properties": {
    "Saturation": {
      "type": "integer"
    },
    "TransitionTime": {
      "type": "integer"
    },
    "OptionsMask": {
      "type": "CCColorOptions"
    },
    "OptionsOverride": {
      "type": "CCColorOptions"
    }
  },
  "required": [
    "Saturation",
    "TransitionTime",
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ColorControl/MoveToSaturation command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/Commands/MoveToSaturation' -m  '{ "Saturation": <SATURATION_VALUE>,"TransitionTime": <TRANSITION_TIME_VALUE>,"OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a ColorControl/MoveToSaturation generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/GeneratedCommands/MoveToSaturation'

\subsection color_control_move_saturation_cmd ColorControl/MoveSaturation Command

MQTT Topic Pattern:

[PREFIX]/ColorControl/Commands/MoveSaturation
[PREFIX]/ColorControl/GeneratedCommands/MoveSaturation

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster MoveSaturation Command Properties",
  "type": "object",
  "properties": {
    "MoveMode": {
      "type": "CCMoveMode"
    },
    "Rate": {
      "type": "integer"
    },
    "OptionsMask": {
      "type": "CCColorOptions"
    },
    "OptionsOverride": {
      "type": "CCColorOptions"
    }
  },
  "required": [
    "MoveMode",
    "Rate",
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ColorControl/MoveSaturation command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/Commands/MoveSaturation' -m  '{ "MoveMode": <MOVE_MODE_VALUE>,"Rate": <RATE_VALUE>,"OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a ColorControl/MoveSaturation generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/GeneratedCommands/MoveSaturation'

\subsection color_control_step_saturation_cmd ColorControl/StepSaturation Command

MQTT Topic Pattern:

[PREFIX]/ColorControl/Commands/StepSaturation
[PREFIX]/ColorControl/GeneratedCommands/StepSaturation

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster StepSaturation Command Properties",
  "type": "object",
  "properties": {
    "StepMode": {
      "type": "CCStepMode"
    },
    "StepSize": {
      "type": "integer"
    },
    "TransitionTime": {
      "type": "integer"
    },
    "OptionsMask": {
      "type": "CCColorOptions"
    },
    "OptionsOverride": {
      "type": "CCColorOptions"
    }
  },
  "required": [
    "StepMode",
    "StepSize",
    "TransitionTime",
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ColorControl/StepSaturation command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/Commands/StepSaturation' -m  '{ "StepMode": <STEP_MODE_VALUE>,"StepSize": <STEP_SIZE_VALUE>,"TransitionTime": <TRANSITION_TIME_VALUE>,"OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a ColorControl/StepSaturation generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/GeneratedCommands/StepSaturation'

\subsection color_control_move_to_hue_and_saturation_cmd ColorControl/MoveToHueAndSaturation Command

MQTT Topic Pattern:

[PREFIX]/ColorControl/Commands/MoveToHueAndSaturation
[PREFIX]/ColorControl/GeneratedCommands/MoveToHueAndSaturation

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster MoveToHueAndSaturation Command Properties",
  "type": "object",
  "properties": {
    "Hue": {
      "type": "integer"
    },
    "Saturation": {
      "type": "integer"
    },
    "TransitionTime": {
      "type": "integer"
    },
    "OptionsMask": {
      "type": "CCColorOptions"
    },
    "OptionsOverride": {
      "type": "CCColorOptions"
    }
  },
  "required": [
    "Hue",
    "Saturation",
    "TransitionTime",
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ColorControl/MoveToHueAndSaturation command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/Commands/MoveToHueAndSaturation' -m  '{ "Hue": <HUE_VALUE>,"Saturation": <SATURATION_VALUE>,"TransitionTime": <TRANSITION_TIME_VALUE>,"OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a ColorControl/MoveToHueAndSaturation generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/GeneratedCommands/MoveToHueAndSaturation'

\subsection color_control_move_to_color_cmd ColorControl/MoveToColor Command

MQTT Topic Pattern:

[PREFIX]/ColorControl/Commands/MoveToColor
[PREFIX]/ColorControl/GeneratedCommands/MoveToColor

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster MoveToColor Command Properties",
  "type": "object",
  "properties": {
    "ColorX": {
      "type": "integer"
    },
    "ColorY": {
      "type": "integer"
    },
    "TransitionTime": {
      "type": "integer"
    },
    "OptionsMask": {
      "type": "CCColorOptions"
    },
    "OptionsOverride": {
      "type": "CCColorOptions"
    }
  },
  "required": [
    "ColorX",
    "ColorY",
    "TransitionTime",
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ColorControl/MoveToColor command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/Commands/MoveToColor' -m  '{ "ColorX": <COLORX_VALUE>,"ColorY": <COLORY_VALUE>,"TransitionTime": <TRANSITION_TIME_VALUE>,"OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a ColorControl/MoveToColor generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/GeneratedCommands/MoveToColor'

\subsection color_control_move_color_cmd ColorControl/MoveColor Command

MQTT Topic Pattern:

[PREFIX]/ColorControl/Commands/MoveColor
[PREFIX]/ColorControl/GeneratedCommands/MoveColor

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster MoveColor Command Properties",
  "type": "object",
  "properties": {
    "RateX": {
      "type": "integer"
    },
    "RateY": {
      "type": "integer"
    },
    "OptionsMask": {
      "type": "CCColorOptions"
    },
    "OptionsOverride": {
      "type": "CCColorOptions"
    }
  },
  "required": [
    "RateX",
    "RateY",
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ColorControl/MoveColor command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/Commands/MoveColor' -m  '{ "RateX": <RATEX_VALUE>,"RateY": <RATEY_VALUE>,"OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a ColorControl/MoveColor generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/GeneratedCommands/MoveColor'

\subsection color_control_step_color_cmd ColorControl/StepColor Command

MQTT Topic Pattern:

[PREFIX]/ColorControl/Commands/StepColor
[PREFIX]/ColorControl/GeneratedCommands/StepColor

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster StepColor Command Properties",
  "type": "object",
  "properties": {
    "StepX": {
      "type": "integer"
    },
    "StepY": {
      "type": "integer"
    },
    "TransitionTime": {
      "type": "integer"
    },
    "OptionsMask": {
      "type": "CCColorOptions"
    },
    "OptionsOverride": {
      "type": "CCColorOptions"
    }
  },
  "required": [
    "StepX",
    "StepY",
    "TransitionTime",
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ColorControl/StepColor command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/Commands/StepColor' -m  '{ "StepX": <STEPX_VALUE>,"StepY": <STEPY_VALUE>,"TransitionTime": <TRANSITION_TIME_VALUE>,"OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a ColorControl/StepColor generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/GeneratedCommands/StepColor'

\subsection color_control_move_to_color_temperature_cmd ColorControl/MoveToColorTemperature Command

MQTT Topic Pattern:

[PREFIX]/ColorControl/Commands/MoveToColorTemperature
[PREFIX]/ColorControl/GeneratedCommands/MoveToColorTemperature

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster MoveToColorTemperature Command Properties",
  "type": "object",
  "properties": {
    "ColorTemperatureMireds": {
      "type": "integer"
    },
    "TransitionTime": {
      "type": "integer"
    },
    "OptionsMask": {
      "type": "CCColorOptions"
    },
    "OptionsOverride": {
      "type": "CCColorOptions"
    }
  },
  "required": [
    "ColorTemperatureMireds",
    "TransitionTime",
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ColorControl/MoveToColorTemperature command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/Commands/MoveToColorTemperature' -m  '{ "ColorTemperatureMireds": <COLOR_TEMPERATURE_MIREDS_VALUE>,"TransitionTime": <TRANSITION_TIME_VALUE>,"OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a ColorControl/MoveToColorTemperature generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/GeneratedCommands/MoveToColorTemperature'

\subsection color_control_enhanced_move_to_hue_cmd ColorControl/EnhancedMoveToHue Command

MQTT Topic Pattern:

[PREFIX]/ColorControl/Commands/EnhancedMoveToHue
[PREFIX]/ColorControl/GeneratedCommands/EnhancedMoveToHue

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster EnhancedMoveToHue Command Properties",
  "type": "object",
  "properties": {
    "EnhancedHue": {
      "type": "integer"
    },
    "Direction": {
      "type": "CCDirection"
    },
    "TransitionTime": {
      "type": "integer"
    },
    "OptionsMask": {
      "type": "CCColorOptions"
    },
    "OptionsOverride": {
      "type": "CCColorOptions"
    }
  },
  "required": [
    "EnhancedHue",
    "Direction",
    "TransitionTime",
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ColorControl/EnhancedMoveToHue command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/Commands/EnhancedMoveToHue' -m  '{ "EnhancedHue": <ENHANCED_HUE_VALUE>,"Direction": <DIRECTION_VALUE>,"TransitionTime": <TRANSITION_TIME_VALUE>,"OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a ColorControl/EnhancedMoveToHue generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/GeneratedCommands/EnhancedMoveToHue'

\subsection color_control_enhanced_move_hue_cmd ColorControl/EnhancedMoveHue Command

MQTT Topic Pattern:

[PREFIX]/ColorControl/Commands/EnhancedMoveHue
[PREFIX]/ColorControl/GeneratedCommands/EnhancedMoveHue

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster EnhancedMoveHue Command Properties",
  "type": "object",
  "properties": {
    "MoveMode": {
      "type": "CCMoveMode"
    },
    "Rate": {
      "type": "integer"
    },
    "OptionsMask": {
      "type": "CCColorOptions"
    },
    "OptionsOverride": {
      "type": "CCColorOptions"
    }
  },
  "required": [
    "MoveMode",
    "Rate",
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ColorControl/EnhancedMoveHue command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/Commands/EnhancedMoveHue' -m  '{ "MoveMode": <MOVE_MODE_VALUE>,"Rate": <RATE_VALUE>,"OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a ColorControl/EnhancedMoveHue generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/GeneratedCommands/EnhancedMoveHue'

\subsection color_control_enhanced_step_hue_cmd ColorControl/EnhancedStepHue Command

MQTT Topic Pattern:

[PREFIX]/ColorControl/Commands/EnhancedStepHue
[PREFIX]/ColorControl/GeneratedCommands/EnhancedStepHue

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster EnhancedStepHue Command Properties",
  "type": "object",
  "properties": {
    "StepMode": {
      "type": "CCStepMode"
    },
    "StepSize": {
      "type": "integer"
    },
    "TransitionTime": {
      "type": "integer"
    },
    "OptionsMask": {
      "type": "CCColorOptions"
    },
    "OptionsOverride": {
      "type": "CCColorOptions"
    }
  },
  "required": [
    "StepMode",
    "StepSize",
    "TransitionTime",
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ColorControl/EnhancedStepHue command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/Commands/EnhancedStepHue' -m  '{ "StepMode": <STEP_MODE_VALUE>,"StepSize": <STEP_SIZE_VALUE>,"TransitionTime": <TRANSITION_TIME_VALUE>,"OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a ColorControl/EnhancedStepHue generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/GeneratedCommands/EnhancedStepHue'

\subsection color_control_enhanced_move_to_hue_and_saturation_cmd ColorControl/EnhancedMoveToHueAndSaturation Command

MQTT Topic Pattern:

[PREFIX]/ColorControl/Commands/EnhancedMoveToHueAndSaturation
[PREFIX]/ColorControl/GeneratedCommands/EnhancedMoveToHueAndSaturation

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster EnhancedMoveToHueAndSaturation Command Properties",
  "type": "object",
  "properties": {
    "EnhancedHue": {
      "type": "integer"
    },
    "Saturation": {
      "type": "integer"
    },
    "TransitionTime": {
      "type": "integer"
    },
    "OptionsMask": {
      "type": "CCColorOptions"
    },
    "OptionsOverride": {
      "type": "CCColorOptions"
    }
  },
  "required": [
    "EnhancedHue",
    "Saturation",
    "TransitionTime",
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ColorControl/EnhancedMoveToHueAndSaturation command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/Commands/EnhancedMoveToHueAndSaturation' -m  '{ "EnhancedHue": <ENHANCED_HUE_VALUE>,"Saturation": <SATURATION_VALUE>,"TransitionTime": <TRANSITION_TIME_VALUE>,"OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a ColorControl/EnhancedMoveToHueAndSaturation generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/GeneratedCommands/EnhancedMoveToHueAndSaturation'

\subsection color_control_color_loop_set_cmd ColorControl/ColorLoopSet Command

MQTT Topic Pattern:

[PREFIX]/ColorControl/Commands/ColorLoopSet
[PREFIX]/ColorControl/GeneratedCommands/ColorLoopSet

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster ColorLoopSet Command Properties",
  "type": "object",
  "properties": {
    "UpdateFlags": {
      "type": "ColorLoopSetUpdateFlags"
    },
    "Action": {
      "type": "ColorLoopSetAction"
    },
    "Direction": {
      "type": "CCColorLoopDirection"
    },
    "Time": {
      "type": "integer"
    },
    "StartHue": {
      "type": "integer"
    },
    "OptionsMask": {
      "type": "CCColorOptions"
    },
    "OptionsOverride": {
      "type": "CCColorOptions"
    }
  },
  "required": [
    "UpdateFlags",
    "Action",
    "Direction",
    "Time",
    "StartHue",
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ColorControl/ColorLoopSet command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/Commands/ColorLoopSet' -m  '{ "UpdateFlags": <UPDATE_FLAGS_VALUE>,"Action": <ACTION_VALUE>,"Direction": <DIRECTION_VALUE>,"Time": <TIME_VALUE>,"StartHue": <START_HUE_VALUE>,"OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a ColorControl/ColorLoopSet generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/GeneratedCommands/ColorLoopSet'

\subsection color_control_stop_move_step_cmd ColorControl/StopMoveStep Command

MQTT Topic Pattern:

[PREFIX]/ColorControl/Commands/StopMoveStep
[PREFIX]/ColorControl/GeneratedCommands/StopMoveStep

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster StopMoveStep Command Properties",
  "type": "object",
  "properties": {
    "OptionsMask": {
      "type": "CCColorOptions"
    },
    "OptionsOverride": {
      "type": "CCColorOptions"
    }
  },
  "required": [
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ColorControl/StopMoveStep command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/Commands/StopMoveStep' -m  '{ "OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a ColorControl/StopMoveStep generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/GeneratedCommands/StopMoveStep'

\subsection color_control_move_color_temperature_cmd ColorControl/MoveColorTemperature Command

MQTT Topic Pattern:

[PREFIX]/ColorControl/Commands/MoveColorTemperature
[PREFIX]/ColorControl/GeneratedCommands/MoveColorTemperature

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster MoveColorTemperature Command Properties",
  "type": "object",
  "properties": {
    "MoveMode": {
      "type": "CCMoveMode"
    },
    "Rate": {
      "type": "integer"
    },
    "ColorTemperatureMinimumMireds": {
      "type": "CCMinMiredsField"
    },
    "ColorTemperatureMaximumMireds": {
      "type": "CCMaxMiredsField"
    },
    "OptionsMask": {
      "type": "CCColorOptions"
    },
    "OptionsOverride": {
      "type": "CCColorOptions"
    }
  },
  "required": [
    "MoveMode",
    "Rate",
    "ColorTemperatureMinimumMireds",
    "ColorTemperatureMaximumMireds",
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ColorControl/MoveColorTemperature command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/Commands/MoveColorTemperature' -m  '{ "MoveMode": <MOVE_MODE_VALUE>,"Rate": <RATE_VALUE>,"ColorTemperatureMinimumMireds": <COLOR_TEMPERATURE_MINIMUM_MIREDS_VALUE>,"ColorTemperatureMaximumMireds": <COLOR_TEMPERATURE_MAXIMUM_MIREDS_VALUE>,"OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a ColorControl/MoveColorTemperature generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/GeneratedCommands/MoveColorTemperature'

\subsection color_control_step_color_temperature_cmd ColorControl/StepColorTemperature Command

MQTT Topic Pattern:

[PREFIX]/ColorControl/Commands/StepColorTemperature
[PREFIX]/ColorControl/GeneratedCommands/StepColorTemperature

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster StepColorTemperature Command Properties",
  "type": "object",
  "properties": {
    "StepMode": {
      "type": "CCStepMode"
    },
    "StepSize": {
      "type": "integer"
    },
    "TransitionTime": {
      "type": "integer"
    },
    "ColorTemperatureMinimumMireds": {
      "type": "CCMinMiredsField"
    },
    "ColorTemperatureMaximumMireds": {
      "type": "CCMaxMiredsField"
    },
    "OptionsMask": {
      "type": "CCColorOptions"
    },
    "OptionsOverride": {
      "type": "CCColorOptions"
    }
  },
  "required": [
    "StepMode",
    "StepSize",
    "TransitionTime",
    "ColorTemperatureMinimumMireds",
    "ColorTemperatureMaximumMireds",
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ColorControl/StepColorTemperature command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/Commands/StepColorTemperature' -m  '{ "StepMode": <STEP_MODE_VALUE>,"StepSize": <STEP_SIZE_VALUE>,"TransitionTime": <TRANSITION_TIME_VALUE>,"ColorTemperatureMinimumMireds": <COLOR_TEMPERATURE_MINIMUM_MIREDS_VALUE>,"ColorTemperatureMaximumMireds": <COLOR_TEMPERATURE_MAXIMUM_MIREDS_VALUE>,"OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a ColorControl/StepColorTemperature generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/GeneratedCommands/StepColorTemperature'

\subsection color_control_write_attr_cmd ColorControl/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/ColorControl/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
    "Options": {
      "type": "CCColorOptions"
    },
    "WhitePointX": {
      "type": "integer"
    },
    "WhitePointY": {
      "type": "integer"
    },
    "ColorPointRX": {
      "type": "integer"
    },
    "ColorPointRY": {
      "type": "integer"
    },
    "ColorPointRIntensity": {
      "type": "integer"
    },
    "ColorPointGX": {
      "type": "integer"
    },
    "ColorPointGY": {
      "type": "integer"
    },
    "ColorPointGIntensity": {
      "type": "integer"
    },
    "ColorPointBX": {
      "type": "integer"
    },
    "ColorPointBY": {
      "type": "integer"
    },
    "ColorPointBIntensity": {
      "type": "integer"
    },
    "StartUpColorTemperatureMireds": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all ColorControl attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/Commands/WriteAttributes' -m  '{ "Options": <OPTIONS_VALUE> ,"WhitePointX": <WHITE_POINTX_VALUE> ,"WhitePointY": <WHITE_POINTY_VALUE> ,"ColorPointRX": <COLOR_POINTRX_VALUE> ,"ColorPointRY": <COLOR_POINTRY_VALUE> ,"ColorPointRIntensity": <COLOR_POINTR_INTENSITY_VALUE> ,"ColorPointGX": <COLOR_POINTGX_VALUE> ,"ColorPointGY": <COLOR_POINTGY_VALUE> ,"ColorPointGIntensity": <COLOR_POINTG_INTENSITY_VALUE> ,"ColorPointBX": <COLOR_POINTBX_VALUE> ,"ColorPointBY": <COLOR_POINTBY_VALUE> ,"ColorPointBIntensity": <COLOR_POINTB_INTENSITY_VALUE> ,"StartUpColorTemperatureMireds": <START_UP_COLOR_TEMPERATURE_MIREDS_VALUE>  }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection color_control_force_read_attr_cmd ColorControl/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/ColorControl/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "CurrentHue",
          "CurrentSaturation",
          "RemainingTime",
          "CurrentX",
          "CurrentY",
          "DriftCompensation",
          "CompensationText",
          "ColorTemperatureMireds",
          "ColorMode",
          "Options",
          "NumberOfPrimaries",
          "Primary1X",
          "Primary1Y",
          "Primary1Intensity",
          "Primary2X",
          "Primary2Y",
          "Primary2Intensity",
          "Primary3X",
          "Primary3Y",
          "Primary3Intensity",
          "Primary4X",
          "Primary4Y",
          "Primary4Intensity",
          "Primary5X",
          "Primary5Y",
          "Primary5Intensity",
          "Primary6X",
          "Primary6Y",
          "Primary6Intensity",
          "WhitePointX",
          "WhitePointY",
          "ColorPointRX",
          "ColorPointRY",
          "ColorPointRIntensity",
          "ColorPointGX",
          "ColorPointGY",
          "ColorPointGIntensity",
          "ColorPointBX",
          "ColorPointBY",
          "ColorPointBIntensity",
          "EnhancedCurrentHue",
          "EnhancedColorMode",
          "ColorLoopActive",
          "ColorLoopDirection",
          "ColorLoopTime",
          "ColorLoopStartEnhancedHue",
          "ColorLoopStoredEnhancedHue",
          "ColorCapabilities",
          "ColorTempPhysicalMinMireds",
          "ColorTempPhysicalMaxMireds",
          "CoupleColorTempToLevelMinMireds",
          "StartUpColorTemperatureMireds"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all ColorControl attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the ColorControl attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/Commands/ForceReadAttributes' -m  '{ "value": ["CurrentHue"] }'

\page ballast_configuration BallastConfiguration Cluster The following commands and attributes are accepted as JSON payloads for the BallastConfiguration cluster.

\section ballast_configuration_attrs BallastConfiguration Attributes The following attribute topics are used to retrieve the BallastConfiguration cluster state.

\subsection ballast_configuration_attr_physical_min_level BallastConfiguration/PhysicalMinLevel Attribute

MQTT Topic Pattern:

[PREFIX]/BallastConfiguration/Attributes/PhysicalMinLevel/Reported
[PREFIX]/BallastConfiguration/Attributes/PhysicalMinLevel/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BallastConfiguration Cluster PhysicalMinLevel Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for PhysicalMinLevel attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/BallastConfiguration/Attributes/PhysicalMinLevel/+'

# Example output

ucl/by-unid/<UNID>/ep0/BallastConfiguration/Attributes/PhysicalMinLevel/Desired { "value": <DESIRED_PHYSICAL_MIN_LEVEL>}
ucl/by-unid/<UNID>/ep0/BallastConfiguration/Attributes/PhysicalMinLevel/Reported { "value": <REPORTED_PHYSICAL_MIN_LEVEL>}

\subsection ballast_configuration_attr_physical_max_level BallastConfiguration/PhysicalMaxLevel Attribute

MQTT Topic Pattern:

[PREFIX]/BallastConfiguration/Attributes/PhysicalMaxLevel/Reported
[PREFIX]/BallastConfiguration/Attributes/PhysicalMaxLevel/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BallastConfiguration Cluster PhysicalMaxLevel Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for PhysicalMaxLevel attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/BallastConfiguration/Attributes/PhysicalMaxLevel/+'

# Example output

ucl/by-unid/<UNID>/ep0/BallastConfiguration/Attributes/PhysicalMaxLevel/Desired { "value": <DESIRED_PHYSICAL_MAX_LEVEL>}
ucl/by-unid/<UNID>/ep0/BallastConfiguration/Attributes/PhysicalMaxLevel/Reported { "value": <REPORTED_PHYSICAL_MAX_LEVEL>}

\subsection ballast_configuration_attr_ballast_status BallastConfiguration/BallastStatus Attribute

MQTT Topic Pattern:

[PREFIX]/BallastConfiguration/Attributes/BallastStatus/Reported
[PREFIX]/BallastConfiguration/Attributes/BallastStatus/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BallastConfiguration Cluster BallastStatus Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "BallastConfigurationBallastStatus"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for BallastStatus attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/BallastConfiguration/Attributes/BallastStatus/+'

# Example output

ucl/by-unid/<UNID>/ep0/BallastConfiguration/Attributes/BallastStatus/Desired { "value": <DESIRED_BALLAST_STATUS>}
ucl/by-unid/<UNID>/ep0/BallastConfiguration/Attributes/BallastStatus/Reported { "value": <REPORTED_BALLAST_STATUS>}

\subsection ballast_configuration_attr_min_level BallastConfiguration/MinLevel Attribute

MQTT Topic Pattern:

[PREFIX]/BallastConfiguration/Attributes/MinLevel/Reported
[PREFIX]/BallastConfiguration/Attributes/MinLevel/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BallastConfiguration Cluster MinLevel Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MinLevel attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/BallastConfiguration/Attributes/MinLevel/+'

# Example output

ucl/by-unid/<UNID>/ep0/BallastConfiguration/Attributes/MinLevel/Desired { "value": <DESIRED_MIN_LEVEL>}
ucl/by-unid/<UNID>/ep0/BallastConfiguration/Attributes/MinLevel/Reported { "value": <REPORTED_MIN_LEVEL>}

\subsection ballast_configuration_attr_max_level BallastConfiguration/MaxLevel Attribute

MQTT Topic Pattern:

[PREFIX]/BallastConfiguration/Attributes/MaxLevel/Reported
[PREFIX]/BallastConfiguration/Attributes/MaxLevel/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BallastConfiguration Cluster MaxLevel Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MaxLevel attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/BallastConfiguration/Attributes/MaxLevel/+'

# Example output

ucl/by-unid/<UNID>/ep0/BallastConfiguration/Attributes/MaxLevel/Desired { "value": <DESIRED_MAX_LEVEL>}
ucl/by-unid/<UNID>/ep0/BallastConfiguration/Attributes/MaxLevel/Reported { "value": <REPORTED_MAX_LEVEL>}

\subsection ballast_configuration_attr_power_on_level BallastConfiguration/PowerOnLevel Attribute

MQTT Topic Pattern:

[PREFIX]/BallastConfiguration/Attributes/PowerOnLevel/Reported
[PREFIX]/BallastConfiguration/Attributes/PowerOnLevel/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BallastConfiguration Cluster PowerOnLevel Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for PowerOnLevel attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/BallastConfiguration/Attributes/PowerOnLevel/+'

# Example output

ucl/by-unid/<UNID>/ep0/BallastConfiguration/Attributes/PowerOnLevel/Desired { "value": <DESIRED_POWER_ON_LEVEL>}
ucl/by-unid/<UNID>/ep0/BallastConfiguration/Attributes/PowerOnLevel/Reported { "value": <REPORTED_POWER_ON_LEVEL>}

\subsection ballast_configuration_attr_power_on_fade_time BallastConfiguration/PowerOnFadeTime Attribute

MQTT Topic Pattern:

[PREFIX]/BallastConfiguration/Attributes/PowerOnFadeTime/Reported
[PREFIX]/BallastConfiguration/Attributes/PowerOnFadeTime/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BallastConfiguration Cluster PowerOnFadeTime Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for PowerOnFadeTime attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/BallastConfiguration/Attributes/PowerOnFadeTime/+'

# Example output

ucl/by-unid/<UNID>/ep0/BallastConfiguration/Attributes/PowerOnFadeTime/Desired { "value": <DESIRED_POWER_ON_FADE_TIME>}
ucl/by-unid/<UNID>/ep0/BallastConfiguration/Attributes/PowerOnFadeTime/Reported { "value": <REPORTED_POWER_ON_FADE_TIME>}

\subsection ballast_configuration_attr_intrinsic_ballast_factor BallastConfiguration/IntrinsicBallastFactor Attribute

MQTT Topic Pattern:

[PREFIX]/BallastConfiguration/Attributes/IntrinsicBallastFactor/Reported
[PREFIX]/BallastConfiguration/Attributes/IntrinsicBallastFactor/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BallastConfiguration Cluster IntrinsicBallastFactor Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for IntrinsicBallastFactor attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/BallastConfiguration/Attributes/IntrinsicBallastFactor/+'

# Example output

ucl/by-unid/<UNID>/ep0/BallastConfiguration/Attributes/IntrinsicBallastFactor/Desired { "value": <DESIRED_INTRINSIC_BALLAST_FACTOR>}
ucl/by-unid/<UNID>/ep0/BallastConfiguration/Attributes/IntrinsicBallastFactor/Reported { "value": <REPORTED_INTRINSIC_BALLAST_FACTOR>}

\subsection ballast_configuration_attr_ballast_factor_adjustment BallastConfiguration/BallastFactorAdjustment Attribute

MQTT Topic Pattern:

[PREFIX]/BallastConfiguration/Attributes/BallastFactorAdjustment/Reported
[PREFIX]/BallastConfiguration/Attributes/BallastFactorAdjustment/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BallastConfiguration Cluster BallastFactorAdjustment Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for BallastFactorAdjustment attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/BallastConfiguration/Attributes/BallastFactorAdjustment/+'

# Example output

ucl/by-unid/<UNID>/ep0/BallastConfiguration/Attributes/BallastFactorAdjustment/Desired { "value": <DESIRED_BALLAST_FACTOR_ADJUSTMENT>}
ucl/by-unid/<UNID>/ep0/BallastConfiguration/Attributes/BallastFactorAdjustment/Reported { "value": <REPORTED_BALLAST_FACTOR_ADJUSTMENT>}

\subsection ballast_configuration_attr_lamp_quantity BallastConfiguration/LampQuantity Attribute

MQTT Topic Pattern:

[PREFIX]/BallastConfiguration/Attributes/LampQuantity/Reported
[PREFIX]/BallastConfiguration/Attributes/LampQuantity/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BallastConfiguration Cluster LampQuantity Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for LampQuantity attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/BallastConfiguration/Attributes/LampQuantity/+'

# Example output

ucl/by-unid/<UNID>/ep0/BallastConfiguration/Attributes/LampQuantity/Desired { "value": <DESIRED_LAMP_QUANTITY>}
ucl/by-unid/<UNID>/ep0/BallastConfiguration/Attributes/LampQuantity/Reported { "value": <REPORTED_LAMP_QUANTITY>}

\subsection ballast_configuration_attr_lamp_type BallastConfiguration/LampType Attribute

MQTT Topic Pattern:

[PREFIX]/BallastConfiguration/Attributes/LampType/Reported
[PREFIX]/BallastConfiguration/Attributes/LampType/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BallastConfiguration Cluster LampType Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for LampType attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/BallastConfiguration/Attributes/LampType/+'

# Example output

ucl/by-unid/<UNID>/ep0/BallastConfiguration/Attributes/LampType/Desired { "value": <DESIRED_LAMP_TYPE>}
ucl/by-unid/<UNID>/ep0/BallastConfiguration/Attributes/LampType/Reported { "value": <REPORTED_LAMP_TYPE>}

\subsection ballast_configuration_attr_lamp_manufacturer BallastConfiguration/LampManufacturer Attribute

MQTT Topic Pattern:

[PREFIX]/BallastConfiguration/Attributes/LampManufacturer/Reported
[PREFIX]/BallastConfiguration/Attributes/LampManufacturer/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BallastConfiguration Cluster LampManufacturer Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for LampManufacturer attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/BallastConfiguration/Attributes/LampManufacturer/+'

# Example output

ucl/by-unid/<UNID>/ep0/BallastConfiguration/Attributes/LampManufacturer/Desired { "value": <DESIRED_LAMP_MANUFACTURER>}
ucl/by-unid/<UNID>/ep0/BallastConfiguration/Attributes/LampManufacturer/Reported { "value": <REPORTED_LAMP_MANUFACTURER>}

\subsection ballast_configuration_attr_lamp_rated_hours BallastConfiguration/LampRatedHours Attribute

MQTT Topic Pattern:

[PREFIX]/BallastConfiguration/Attributes/LampRatedHours/Reported
[PREFIX]/BallastConfiguration/Attributes/LampRatedHours/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BallastConfiguration Cluster LampRatedHours Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for LampRatedHours attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/BallastConfiguration/Attributes/LampRatedHours/+'

# Example output

ucl/by-unid/<UNID>/ep0/BallastConfiguration/Attributes/LampRatedHours/Desired { "value": <DESIRED_LAMP_RATED_HOURS>}
ucl/by-unid/<UNID>/ep0/BallastConfiguration/Attributes/LampRatedHours/Reported { "value": <REPORTED_LAMP_RATED_HOURS>}

\subsection ballast_configuration_attr_lamp_burn_hours BallastConfiguration/LampBurnHours Attribute

MQTT Topic Pattern:

[PREFIX]/BallastConfiguration/Attributes/LampBurnHours/Reported
[PREFIX]/BallastConfiguration/Attributes/LampBurnHours/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BallastConfiguration Cluster LampBurnHours Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for LampBurnHours attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/BallastConfiguration/Attributes/LampBurnHours/+'

# Example output

ucl/by-unid/<UNID>/ep0/BallastConfiguration/Attributes/LampBurnHours/Desired { "value": <DESIRED_LAMP_BURN_HOURS>}
ucl/by-unid/<UNID>/ep0/BallastConfiguration/Attributes/LampBurnHours/Reported { "value": <REPORTED_LAMP_BURN_HOURS>}

\subsection ballast_configuration_attr_lamp_alarm_mode BallastConfiguration/LampAlarmMode Attribute

MQTT Topic Pattern:

[PREFIX]/BallastConfiguration/Attributes/LampAlarmMode/Reported
[PREFIX]/BallastConfiguration/Attributes/LampAlarmMode/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BallastConfiguration Cluster LampAlarmMode Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "BallastConfigurationLampAlarmMode"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for LampAlarmMode attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/BallastConfiguration/Attributes/LampAlarmMode/+'

# Example output

ucl/by-unid/<UNID>/ep0/BallastConfiguration/Attributes/LampAlarmMode/Desired { "value": <DESIRED_LAMP_ALARM_MODE>}
ucl/by-unid/<UNID>/ep0/BallastConfiguration/Attributes/LampAlarmMode/Reported { "value": <REPORTED_LAMP_ALARM_MODE>}

\subsection ballast_configuration_attr_lamp_burn_hours_trip_point BallastConfiguration/LampBurnHoursTripPoint Attribute

MQTT Topic Pattern:

[PREFIX]/BallastConfiguration/Attributes/LampBurnHoursTripPoint/Reported
[PREFIX]/BallastConfiguration/Attributes/LampBurnHoursTripPoint/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BallastConfiguration Cluster LampBurnHoursTripPoint Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for LampBurnHoursTripPoint attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/BallastConfiguration/Attributes/LampBurnHoursTripPoint/+'

# Example output

ucl/by-unid/<UNID>/ep0/BallastConfiguration/Attributes/LampBurnHoursTripPoint/Desired { "value": <DESIRED_LAMP_BURN_HOURS_TRIP_POINT>}
ucl/by-unid/<UNID>/ep0/BallastConfiguration/Attributes/LampBurnHoursTripPoint/Reported { "value": <REPORTED_LAMP_BURN_HOURS_TRIP_POINT>}

\subsection ballast_configuration_attr_cluster_revision BallastConfiguration/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/BallastConfiguration/Attributes/ClusterRevision/Reported
[PREFIX]/BallastConfiguration/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BallastConfiguration Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/BallastConfiguration/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/BallastConfiguration/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/BallastConfiguration/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section ballast_configuration_recv_cmd_support BallastConfiguration Command Support

MQTT Topic Pattern:

[PREFIX]/BallastConfiguration/SupportedCommands
[PREFIX]/BallastConfiguration/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BallastConfiguration Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for BallastConfiguration cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/BallastConfiguration/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/BallastConfiguration/SupportedCommands { "value": [] }

To see supported generated commands for BallastConfiguration cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/BallastConfiguration/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/BallastConfiguration/SupportedGeneratedCommands { "value": [] }

\section ballast_configuration_cmds BallastConfiguration Commands

\subsection ballast_configuration_write_attr_cmd BallastConfiguration/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/BallastConfiguration/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BallastConfiguration Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
    "MinLevel": {
      "type": "integer"
    },
    "MaxLevel": {
      "type": "integer"
    },
    "PowerOnLevel": {
      "type": "integer"
    },
    "PowerOnFadeTime": {
      "type": "integer"
    },
    "IntrinsicBallastFactor": {
      "type": "integer"
    },
    "BallastFactorAdjustment": {
      "type": "integer"
    },
    "LampType": {
      "type": "string"
    },
    "LampManufacturer": {
      "type": "string"
    },
    "LampRatedHours": {
      "type": "integer"
    },
    "LampBurnHours": {
      "type": "integer"
    },
    "LampAlarmMode": {
      "type": "BallastConfigurationLampAlarmMode"
    },
    "LampBurnHoursTripPoint": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all BallastConfiguration attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/BallastConfiguration/Commands/WriteAttributes' -m  '{ "MinLevel": <MIN_LEVEL_VALUE> ,"MaxLevel": <MAX_LEVEL_VALUE> ,"PowerOnLevel": <POWER_ON_LEVEL_VALUE> ,"PowerOnFadeTime": <POWER_ON_FADE_TIME_VALUE> ,"IntrinsicBallastFactor": <INTRINSIC_BALLAST_FACTOR_VALUE> ,"BallastFactorAdjustment": <BALLAST_FACTOR_ADJUSTMENT_VALUE> ,"LampType": <LAMP_TYPE_VALUE> ,"LampManufacturer": <LAMP_MANUFACTURER_VALUE> ,"LampRatedHours": <LAMP_RATED_HOURS_VALUE> ,"LampBurnHours": <LAMP_BURN_HOURS_VALUE> ,"LampAlarmMode": <LAMP_ALARM_MODE_VALUE> ,"LampBurnHoursTripPoint": <LAMP_BURN_HOURS_TRIP_POINT_VALUE>  }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection ballast_configuration_force_read_attr_cmd BallastConfiguration/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/BallastConfiguration/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BallastConfiguration Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "PhysicalMinLevel",
          "PhysicalMaxLevel",
          "BallastStatus",
          "MinLevel",
          "MaxLevel",
          "PowerOnLevel",
          "PowerOnFadeTime",
          "IntrinsicBallastFactor",
          "BallastFactorAdjustment",
          "LampQuantity",
          "LampType",
          "LampManufacturer",
          "LampRatedHours",
          "LampBurnHours",
          "LampAlarmMode",
          "LampBurnHoursTripPoint"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all BallastConfiguration attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/BallastConfiguration/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the BallastConfiguration attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/BallastConfiguration/Commands/ForceReadAttributes' -m  '{ "value": ["PhysicalMinLevel"] }'

\page illuminance_measurement IlluminanceMeasurement Cluster The following commands and attributes are accepted as JSON payloads for the IlluminanceMeasurement cluster.

\section illuminance_measurement_attrs IlluminanceMeasurement Attributes The following attribute topics are used to retrieve the IlluminanceMeasurement cluster state.

\subsection illuminance_measurement_attr_measured_value IlluminanceMeasurement/MeasuredValue Attribute

MQTT Topic Pattern:

[PREFIX]/IlluminanceMeasurement/Attributes/MeasuredValue/Reported
[PREFIX]/IlluminanceMeasurement/Attributes/MeasuredValue/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IlluminanceMeasurement Cluster MeasuredValue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MeasuredValue attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/IlluminanceMeasurement/Attributes/MeasuredValue/+'

# Example output

ucl/by-unid/<UNID>/ep0/IlluminanceMeasurement/Attributes/MeasuredValue/Desired { "value": <DESIRED_MEASURED_VALUE>}
ucl/by-unid/<UNID>/ep0/IlluminanceMeasurement/Attributes/MeasuredValue/Reported { "value": <REPORTED_MEASURED_VALUE>}

\subsection illuminance_measurement_attr_min_measured_value IlluminanceMeasurement/MinMeasuredValue Attribute

MQTT Topic Pattern:

[PREFIX]/IlluminanceMeasurement/Attributes/MinMeasuredValue/Reported
[PREFIX]/IlluminanceMeasurement/Attributes/MinMeasuredValue/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IlluminanceMeasurement Cluster MinMeasuredValue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MinMeasuredValue attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/IlluminanceMeasurement/Attributes/MinMeasuredValue/+'

# Example output

ucl/by-unid/<UNID>/ep0/IlluminanceMeasurement/Attributes/MinMeasuredValue/Desired { "value": <DESIRED_MIN_MEASURED_VALUE>}
ucl/by-unid/<UNID>/ep0/IlluminanceMeasurement/Attributes/MinMeasuredValue/Reported { "value": <REPORTED_MIN_MEASURED_VALUE>}

\subsection illuminance_measurement_attr_max_measured_value IlluminanceMeasurement/MaxMeasuredValue Attribute

MQTT Topic Pattern:

[PREFIX]/IlluminanceMeasurement/Attributes/MaxMeasuredValue/Reported
[PREFIX]/IlluminanceMeasurement/Attributes/MaxMeasuredValue/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IlluminanceMeasurement Cluster MaxMeasuredValue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MaxMeasuredValue attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/IlluminanceMeasurement/Attributes/MaxMeasuredValue/+'

# Example output

ucl/by-unid/<UNID>/ep0/IlluminanceMeasurement/Attributes/MaxMeasuredValue/Desired { "value": <DESIRED_MAX_MEASURED_VALUE>}
ucl/by-unid/<UNID>/ep0/IlluminanceMeasurement/Attributes/MaxMeasuredValue/Reported { "value": <REPORTED_MAX_MEASURED_VALUE>}

\subsection illuminance_measurement_attr_tolerance IlluminanceMeasurement/Tolerance Attribute

MQTT Topic Pattern:

[PREFIX]/IlluminanceMeasurement/Attributes/Tolerance/Reported
[PREFIX]/IlluminanceMeasurement/Attributes/Tolerance/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IlluminanceMeasurement Cluster Tolerance Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Tolerance attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/IlluminanceMeasurement/Attributes/Tolerance/+'

# Example output

ucl/by-unid/<UNID>/ep0/IlluminanceMeasurement/Attributes/Tolerance/Desired { "value": <DESIRED_TOLERANCE>}
ucl/by-unid/<UNID>/ep0/IlluminanceMeasurement/Attributes/Tolerance/Reported { "value": <REPORTED_TOLERANCE>}

\subsection illuminance_measurement_attr_light_sensor_type IlluminanceMeasurement/LightSensorType Attribute

MQTT Topic Pattern:

[PREFIX]/IlluminanceMeasurement/Attributes/LightSensorType/Reported
[PREFIX]/IlluminanceMeasurement/Attributes/LightSensorType/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IlluminanceMeasurement Cluster LightSensorType Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "IlluminanceMeasurementLightSensorType"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for LightSensorType attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/IlluminanceMeasurement/Attributes/LightSensorType/+'

# Example output

ucl/by-unid/<UNID>/ep0/IlluminanceMeasurement/Attributes/LightSensorType/Desired { "value": <DESIRED_LIGHT_SENSOR_TYPE>}
ucl/by-unid/<UNID>/ep0/IlluminanceMeasurement/Attributes/LightSensorType/Reported { "value": <REPORTED_LIGHT_SENSOR_TYPE>}

\subsection illuminance_measurement_attr_cluster_revision IlluminanceMeasurement/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/IlluminanceMeasurement/Attributes/ClusterRevision/Reported
[PREFIX]/IlluminanceMeasurement/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IlluminanceMeasurement Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/IlluminanceMeasurement/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/IlluminanceMeasurement/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/IlluminanceMeasurement/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section illuminance_measurement_recv_cmd_support IlluminanceMeasurement Command Support

MQTT Topic Pattern:

[PREFIX]/IlluminanceMeasurement/SupportedCommands
[PREFIX]/IlluminanceMeasurement/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IlluminanceMeasurement Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for IlluminanceMeasurement cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/IlluminanceMeasurement/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/IlluminanceMeasurement/SupportedCommands { "value": [] }

To see supported generated commands for IlluminanceMeasurement cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/IlluminanceMeasurement/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/IlluminanceMeasurement/SupportedGeneratedCommands { "value": [] }

\section illuminance_measurement_cmds IlluminanceMeasurement Commands

\subsection illuminance_measurement_write_attr_cmd IlluminanceMeasurement/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/IlluminanceMeasurement/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IlluminanceMeasurement Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all IlluminanceMeasurement attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/IlluminanceMeasurement/Commands/WriteAttributes' -m  '{  }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection illuminance_measurement_force_read_attr_cmd IlluminanceMeasurement/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/IlluminanceMeasurement/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IlluminanceMeasurement Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "MeasuredValue",
          "MinMeasuredValue",
          "MaxMeasuredValue",
          "Tolerance",
          "LightSensorType"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all IlluminanceMeasurement attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/IlluminanceMeasurement/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the IlluminanceMeasurement attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/IlluminanceMeasurement/Commands/ForceReadAttributes' -m  '{ "value": ["MeasuredValue"] }'

\page illuminance_level_sensing IlluminanceLevelSensing Cluster The following commands and attributes are accepted as JSON payloads for the IlluminanceLevelSensing cluster.

\section illuminance_level_sensing_attrs IlluminanceLevelSensing Attributes The following attribute topics are used to retrieve the IlluminanceLevelSensing cluster state.

\subsection illuminance_level_sensing_attr_level_status IlluminanceLevelSensing/LevelStatus Attribute

MQTT Topic Pattern:

[PREFIX]/IlluminanceLevelSensing/Attributes/LevelStatus/Reported
[PREFIX]/IlluminanceLevelSensing/Attributes/LevelStatus/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IlluminanceLevelSensing Cluster LevelStatus Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "IlluminanceLevelSensingLevelStatus"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for LevelStatus attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/IlluminanceLevelSensing/Attributes/LevelStatus/+'

# Example output

ucl/by-unid/<UNID>/ep0/IlluminanceLevelSensing/Attributes/LevelStatus/Desired { "value": <DESIRED_LEVEL_STATUS>}
ucl/by-unid/<UNID>/ep0/IlluminanceLevelSensing/Attributes/LevelStatus/Reported { "value": <REPORTED_LEVEL_STATUS>}

\subsection illuminance_level_sensing_attr_light_sensor_type IlluminanceLevelSensing/LightSensorType Attribute

MQTT Topic Pattern:

[PREFIX]/IlluminanceLevelSensing/Attributes/LightSensorType/Reported
[PREFIX]/IlluminanceLevelSensing/Attributes/LightSensorType/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IlluminanceLevelSensing Cluster LightSensorType Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "IlluminanceLevelSensingLightSensorType"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for LightSensorType attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/IlluminanceLevelSensing/Attributes/LightSensorType/+'

# Example output

ucl/by-unid/<UNID>/ep0/IlluminanceLevelSensing/Attributes/LightSensorType/Desired { "value": <DESIRED_LIGHT_SENSOR_TYPE>}
ucl/by-unid/<UNID>/ep0/IlluminanceLevelSensing/Attributes/LightSensorType/Reported { "value": <REPORTED_LIGHT_SENSOR_TYPE>}

\subsection illuminance_level_sensing_attr_illuminance_target_level IlluminanceLevelSensing/IlluminanceTargetLevel Attribute

MQTT Topic Pattern:

[PREFIX]/IlluminanceLevelSensing/Attributes/IlluminanceTargetLevel/Reported
[PREFIX]/IlluminanceLevelSensing/Attributes/IlluminanceTargetLevel/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IlluminanceLevelSensing Cluster IlluminanceTargetLevel Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for IlluminanceTargetLevel attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/IlluminanceLevelSensing/Attributes/IlluminanceTargetLevel/+'

# Example output

ucl/by-unid/<UNID>/ep0/IlluminanceLevelSensing/Attributes/IlluminanceTargetLevel/Desired { "value": <DESIRED_ILLUMINANCE_TARGET_LEVEL>}
ucl/by-unid/<UNID>/ep0/IlluminanceLevelSensing/Attributes/IlluminanceTargetLevel/Reported { "value": <REPORTED_ILLUMINANCE_TARGET_LEVEL>}

\subsection illuminance_level_sensing_attr_cluster_revision IlluminanceLevelSensing/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/IlluminanceLevelSensing/Attributes/ClusterRevision/Reported
[PREFIX]/IlluminanceLevelSensing/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IlluminanceLevelSensing Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/IlluminanceLevelSensing/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/IlluminanceLevelSensing/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/IlluminanceLevelSensing/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section illuminance_level_sensing_recv_cmd_support IlluminanceLevelSensing Command Support

MQTT Topic Pattern:

[PREFIX]/IlluminanceLevelSensing/SupportedCommands
[PREFIX]/IlluminanceLevelSensing/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IlluminanceLevelSensing Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for IlluminanceLevelSensing cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/IlluminanceLevelSensing/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/IlluminanceLevelSensing/SupportedCommands { "value": [] }

To see supported generated commands for IlluminanceLevelSensing cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/IlluminanceLevelSensing/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/IlluminanceLevelSensing/SupportedGeneratedCommands { "value": [] }

\section illuminance_level_sensing_cmds IlluminanceLevelSensing Commands

\subsection illuminance_level_sensing_write_attr_cmd IlluminanceLevelSensing/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/IlluminanceLevelSensing/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IlluminanceLevelSensing Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
    "IlluminanceTargetLevel": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all IlluminanceLevelSensing attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/IlluminanceLevelSensing/Commands/WriteAttributes' -m  '{ "IlluminanceTargetLevel": <ILLUMINANCE_TARGET_LEVEL_VALUE>  }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection illuminance_level_sensing_force_read_attr_cmd IlluminanceLevelSensing/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/IlluminanceLevelSensing/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IlluminanceLevelSensing Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "LevelStatus",
          "LightSensorType",
          "IlluminanceTargetLevel"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all IlluminanceLevelSensing attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/IlluminanceLevelSensing/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the IlluminanceLevelSensing attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/IlluminanceLevelSensing/Commands/ForceReadAttributes' -m  '{ "value": ["LevelStatus"] }'

\page temperature_measurement TemperatureMeasurement Cluster The following commands and attributes are accepted as JSON payloads for the TemperatureMeasurement cluster.

\section temperature_measurement_attrs TemperatureMeasurement Attributes The following attribute topics are used to retrieve the TemperatureMeasurement cluster state.

\subsection temperature_measurement_attr_measured_value TemperatureMeasurement/MeasuredValue Attribute

MQTT Topic Pattern:

[PREFIX]/TemperatureMeasurement/Attributes/MeasuredValue/Reported
[PREFIX]/TemperatureMeasurement/Attributes/MeasuredValue/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "TemperatureMeasurement Cluster MeasuredValue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MeasuredValue attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/TemperatureMeasurement/Attributes/MeasuredValue/+'

# Example output

ucl/by-unid/<UNID>/ep0/TemperatureMeasurement/Attributes/MeasuredValue/Desired { "value": <DESIRED_MEASURED_VALUE>}
ucl/by-unid/<UNID>/ep0/TemperatureMeasurement/Attributes/MeasuredValue/Reported { "value": <REPORTED_MEASURED_VALUE>}

\subsection temperature_measurement_attr_min_measured_value TemperatureMeasurement/MinMeasuredValue Attribute

MQTT Topic Pattern:

[PREFIX]/TemperatureMeasurement/Attributes/MinMeasuredValue/Reported
[PREFIX]/TemperatureMeasurement/Attributes/MinMeasuredValue/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "TemperatureMeasurement Cluster MinMeasuredValue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MinMeasuredValue attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/TemperatureMeasurement/Attributes/MinMeasuredValue/+'

# Example output

ucl/by-unid/<UNID>/ep0/TemperatureMeasurement/Attributes/MinMeasuredValue/Desired { "value": <DESIRED_MIN_MEASURED_VALUE>}
ucl/by-unid/<UNID>/ep0/TemperatureMeasurement/Attributes/MinMeasuredValue/Reported { "value": <REPORTED_MIN_MEASURED_VALUE>}

\subsection temperature_measurement_attr_max_measured_value TemperatureMeasurement/MaxMeasuredValue Attribute

MQTT Topic Pattern:

[PREFIX]/TemperatureMeasurement/Attributes/MaxMeasuredValue/Reported
[PREFIX]/TemperatureMeasurement/Attributes/MaxMeasuredValue/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "TemperatureMeasurement Cluster MaxMeasuredValue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MaxMeasuredValue attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/TemperatureMeasurement/Attributes/MaxMeasuredValue/+'

# Example output

ucl/by-unid/<UNID>/ep0/TemperatureMeasurement/Attributes/MaxMeasuredValue/Desired { "value": <DESIRED_MAX_MEASURED_VALUE>}
ucl/by-unid/<UNID>/ep0/TemperatureMeasurement/Attributes/MaxMeasuredValue/Reported { "value": <REPORTED_MAX_MEASURED_VALUE>}

\subsection temperature_measurement_attr_tolerance TemperatureMeasurement/Tolerance Attribute

MQTT Topic Pattern:

[PREFIX]/TemperatureMeasurement/Attributes/Tolerance/Reported
[PREFIX]/TemperatureMeasurement/Attributes/Tolerance/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "TemperatureMeasurement Cluster Tolerance Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Tolerance attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/TemperatureMeasurement/Attributes/Tolerance/+'

# Example output

ucl/by-unid/<UNID>/ep0/TemperatureMeasurement/Attributes/Tolerance/Desired { "value": <DESIRED_TOLERANCE>}
ucl/by-unid/<UNID>/ep0/TemperatureMeasurement/Attributes/Tolerance/Reported { "value": <REPORTED_TOLERANCE>}

\subsection temperature_measurement_attr_cluster_revision TemperatureMeasurement/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/TemperatureMeasurement/Attributes/ClusterRevision/Reported
[PREFIX]/TemperatureMeasurement/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "TemperatureMeasurement Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/TemperatureMeasurement/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/TemperatureMeasurement/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/TemperatureMeasurement/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section temperature_measurement_recv_cmd_support TemperatureMeasurement Command Support

MQTT Topic Pattern:

[PREFIX]/TemperatureMeasurement/SupportedCommands
[PREFIX]/TemperatureMeasurement/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "TemperatureMeasurement Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for TemperatureMeasurement cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/TemperatureMeasurement/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/TemperatureMeasurement/SupportedCommands { "value": [] }

To see supported generated commands for TemperatureMeasurement cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/TemperatureMeasurement/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/TemperatureMeasurement/SupportedGeneratedCommands { "value": [] }

\section temperature_measurement_cmds TemperatureMeasurement Commands

\subsection temperature_measurement_write_attr_cmd TemperatureMeasurement/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/TemperatureMeasurement/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "TemperatureMeasurement Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all TemperatureMeasurement attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/TemperatureMeasurement/Commands/WriteAttributes' -m  '{  }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection temperature_measurement_force_read_attr_cmd TemperatureMeasurement/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/TemperatureMeasurement/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "TemperatureMeasurement Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "MeasuredValue",
          "MinMeasuredValue",
          "MaxMeasuredValue",
          "Tolerance"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all TemperatureMeasurement attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/TemperatureMeasurement/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the TemperatureMeasurement attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/TemperatureMeasurement/Commands/ForceReadAttributes' -m  '{ "value": ["MeasuredValue"] }'

\page pressure_measurement PressureMeasurement Cluster The following commands and attributes are accepted as JSON payloads for the PressureMeasurement cluster.

\section pressure_measurement_attrs PressureMeasurement Attributes The following attribute topics are used to retrieve the PressureMeasurement cluster state.

\subsection pressure_measurement_attr_measured_value PressureMeasurement/MeasuredValue Attribute

MQTT Topic Pattern:

[PREFIX]/PressureMeasurement/Attributes/MeasuredValue/Reported
[PREFIX]/PressureMeasurement/Attributes/MeasuredValue/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PressureMeasurement Cluster MeasuredValue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MeasuredValue attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PressureMeasurement/Attributes/MeasuredValue/+'

# Example output

ucl/by-unid/<UNID>/ep0/PressureMeasurement/Attributes/MeasuredValue/Desired { "value": <DESIRED_MEASURED_VALUE>}
ucl/by-unid/<UNID>/ep0/PressureMeasurement/Attributes/MeasuredValue/Reported { "value": <REPORTED_MEASURED_VALUE>}

\subsection pressure_measurement_attr_min_measured_value PressureMeasurement/MinMeasuredValue Attribute

MQTT Topic Pattern:

[PREFIX]/PressureMeasurement/Attributes/MinMeasuredValue/Reported
[PREFIX]/PressureMeasurement/Attributes/MinMeasuredValue/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PressureMeasurement Cluster MinMeasuredValue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MinMeasuredValue attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PressureMeasurement/Attributes/MinMeasuredValue/+'

# Example output

ucl/by-unid/<UNID>/ep0/PressureMeasurement/Attributes/MinMeasuredValue/Desired { "value": <DESIRED_MIN_MEASURED_VALUE>}
ucl/by-unid/<UNID>/ep0/PressureMeasurement/Attributes/MinMeasuredValue/Reported { "value": <REPORTED_MIN_MEASURED_VALUE>}

\subsection pressure_measurement_attr_max_measured_value PressureMeasurement/MaxMeasuredValue Attribute

MQTT Topic Pattern:

[PREFIX]/PressureMeasurement/Attributes/MaxMeasuredValue/Reported
[PREFIX]/PressureMeasurement/Attributes/MaxMeasuredValue/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PressureMeasurement Cluster MaxMeasuredValue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MaxMeasuredValue attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PressureMeasurement/Attributes/MaxMeasuredValue/+'

# Example output

ucl/by-unid/<UNID>/ep0/PressureMeasurement/Attributes/MaxMeasuredValue/Desired { "value": <DESIRED_MAX_MEASURED_VALUE>}
ucl/by-unid/<UNID>/ep0/PressureMeasurement/Attributes/MaxMeasuredValue/Reported { "value": <REPORTED_MAX_MEASURED_VALUE>}

\subsection pressure_measurement_attr_tolerance PressureMeasurement/Tolerance Attribute

MQTT Topic Pattern:

[PREFIX]/PressureMeasurement/Attributes/Tolerance/Reported
[PREFIX]/PressureMeasurement/Attributes/Tolerance/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PressureMeasurement Cluster Tolerance Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Tolerance attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PressureMeasurement/Attributes/Tolerance/+'

# Example output

ucl/by-unid/<UNID>/ep0/PressureMeasurement/Attributes/Tolerance/Desired { "value": <DESIRED_TOLERANCE>}
ucl/by-unid/<UNID>/ep0/PressureMeasurement/Attributes/Tolerance/Reported { "value": <REPORTED_TOLERANCE>}

\subsection pressure_measurement_attr_scaled_value PressureMeasurement/ScaledValue Attribute

MQTT Topic Pattern:

[PREFIX]/PressureMeasurement/Attributes/ScaledValue/Reported
[PREFIX]/PressureMeasurement/Attributes/ScaledValue/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PressureMeasurement Cluster ScaledValue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ScaledValue attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PressureMeasurement/Attributes/ScaledValue/+'

# Example output

ucl/by-unid/<UNID>/ep0/PressureMeasurement/Attributes/ScaledValue/Desired { "value": <DESIRED_SCALED_VALUE>}
ucl/by-unid/<UNID>/ep0/PressureMeasurement/Attributes/ScaledValue/Reported { "value": <REPORTED_SCALED_VALUE>}

\subsection pressure_measurement_attr_min_scaled_value PressureMeasurement/MinScaledValue Attribute

MQTT Topic Pattern:

[PREFIX]/PressureMeasurement/Attributes/MinScaledValue/Reported
[PREFIX]/PressureMeasurement/Attributes/MinScaledValue/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PressureMeasurement Cluster MinScaledValue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MinScaledValue attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PressureMeasurement/Attributes/MinScaledValue/+'

# Example output

ucl/by-unid/<UNID>/ep0/PressureMeasurement/Attributes/MinScaledValue/Desired { "value": <DESIRED_MIN_SCALED_VALUE>}
ucl/by-unid/<UNID>/ep0/PressureMeasurement/Attributes/MinScaledValue/Reported { "value": <REPORTED_MIN_SCALED_VALUE>}

\subsection pressure_measurement_attr_max_scaled_value PressureMeasurement/MaxScaledValue Attribute

MQTT Topic Pattern:

[PREFIX]/PressureMeasurement/Attributes/MaxScaledValue/Reported
[PREFIX]/PressureMeasurement/Attributes/MaxScaledValue/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PressureMeasurement Cluster MaxScaledValue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MaxScaledValue attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PressureMeasurement/Attributes/MaxScaledValue/+'

# Example output

ucl/by-unid/<UNID>/ep0/PressureMeasurement/Attributes/MaxScaledValue/Desired { "value": <DESIRED_MAX_SCALED_VALUE>}
ucl/by-unid/<UNID>/ep0/PressureMeasurement/Attributes/MaxScaledValue/Reported { "value": <REPORTED_MAX_SCALED_VALUE>}

\subsection pressure_measurement_attr_scaled_tolerance PressureMeasurement/ScaledTolerance Attribute

MQTT Topic Pattern:

[PREFIX]/PressureMeasurement/Attributes/ScaledTolerance/Reported
[PREFIX]/PressureMeasurement/Attributes/ScaledTolerance/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PressureMeasurement Cluster ScaledTolerance Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ScaledTolerance attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PressureMeasurement/Attributes/ScaledTolerance/+'

# Example output

ucl/by-unid/<UNID>/ep0/PressureMeasurement/Attributes/ScaledTolerance/Desired { "value": <DESIRED_SCALED_TOLERANCE>}
ucl/by-unid/<UNID>/ep0/PressureMeasurement/Attributes/ScaledTolerance/Reported { "value": <REPORTED_SCALED_TOLERANCE>}

\subsection pressure_measurement_attr_scale PressureMeasurement/Scale Attribute

MQTT Topic Pattern:

[PREFIX]/PressureMeasurement/Attributes/Scale/Reported
[PREFIX]/PressureMeasurement/Attributes/Scale/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PressureMeasurement Cluster Scale Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Scale attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PressureMeasurement/Attributes/Scale/+'

# Example output

ucl/by-unid/<UNID>/ep0/PressureMeasurement/Attributes/Scale/Desired { "value": <DESIRED_SCALE>}
ucl/by-unid/<UNID>/ep0/PressureMeasurement/Attributes/Scale/Reported { "value": <REPORTED_SCALE>}

\subsection pressure_measurement_attr_cluster_revision PressureMeasurement/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/PressureMeasurement/Attributes/ClusterRevision/Reported
[PREFIX]/PressureMeasurement/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PressureMeasurement Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/PressureMeasurement/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/PressureMeasurement/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/PressureMeasurement/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section pressure_measurement_recv_cmd_support PressureMeasurement Command Support

MQTT Topic Pattern:

[PREFIX]/PressureMeasurement/SupportedCommands
[PREFIX]/PressureMeasurement/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PressureMeasurement Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for PressureMeasurement cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/PressureMeasurement/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/PressureMeasurement/SupportedCommands { "value": [] }

To see supported generated commands for PressureMeasurement cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/PressureMeasurement/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/PressureMeasurement/SupportedGeneratedCommands { "value": [] }

\section pressure_measurement_cmds PressureMeasurement Commands

\subsection pressure_measurement_write_attr_cmd PressureMeasurement/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/PressureMeasurement/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PressureMeasurement Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all PressureMeasurement attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/PressureMeasurement/Commands/WriteAttributes' -m  '{  }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection pressure_measurement_force_read_attr_cmd PressureMeasurement/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/PressureMeasurement/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PressureMeasurement Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "MeasuredValue",
          "MinMeasuredValue",
          "MaxMeasuredValue",
          "Tolerance",
          "ScaledValue",
          "MinScaledValue",
          "MaxScaledValue",
          "ScaledTolerance",
          "Scale"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all PressureMeasurement attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/PressureMeasurement/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the PressureMeasurement attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/PressureMeasurement/Commands/ForceReadAttributes' -m  '{ "value": ["MeasuredValue"] }'

\page flow_measurement FlowMeasurement Cluster The following commands and attributes are accepted as JSON payloads for the FlowMeasurement cluster.

\section flow_measurement_attrs FlowMeasurement Attributes The following attribute topics are used to retrieve the FlowMeasurement cluster state.

\subsection flow_measurement_attr_measured_value FlowMeasurement/MeasuredValue Attribute

MQTT Topic Pattern:

[PREFIX]/FlowMeasurement/Attributes/MeasuredValue/Reported
[PREFIX]/FlowMeasurement/Attributes/MeasuredValue/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "FlowMeasurement Cluster MeasuredValue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MeasuredValue attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/FlowMeasurement/Attributes/MeasuredValue/+'

# Example output

ucl/by-unid/<UNID>/ep0/FlowMeasurement/Attributes/MeasuredValue/Desired { "value": <DESIRED_MEASURED_VALUE>}
ucl/by-unid/<UNID>/ep0/FlowMeasurement/Attributes/MeasuredValue/Reported { "value": <REPORTED_MEASURED_VALUE>}

\subsection flow_measurement_attr_min_measured_value FlowMeasurement/MinMeasuredValue Attribute

MQTT Topic Pattern:

[PREFIX]/FlowMeasurement/Attributes/MinMeasuredValue/Reported
[PREFIX]/FlowMeasurement/Attributes/MinMeasuredValue/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "FlowMeasurement Cluster MinMeasuredValue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MinMeasuredValue attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/FlowMeasurement/Attributes/MinMeasuredValue/+'

# Example output

ucl/by-unid/<UNID>/ep0/FlowMeasurement/Attributes/MinMeasuredValue/Desired { "value": <DESIRED_MIN_MEASURED_VALUE>}
ucl/by-unid/<UNID>/ep0/FlowMeasurement/Attributes/MinMeasuredValue/Reported { "value": <REPORTED_MIN_MEASURED_VALUE>}

\subsection flow_measurement_attr_max_measured_value FlowMeasurement/MaxMeasuredValue Attribute

MQTT Topic Pattern:

[PREFIX]/FlowMeasurement/Attributes/MaxMeasuredValue/Reported
[PREFIX]/FlowMeasurement/Attributes/MaxMeasuredValue/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "FlowMeasurement Cluster MaxMeasuredValue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MaxMeasuredValue attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/FlowMeasurement/Attributes/MaxMeasuredValue/+'

# Example output

ucl/by-unid/<UNID>/ep0/FlowMeasurement/Attributes/MaxMeasuredValue/Desired { "value": <DESIRED_MAX_MEASURED_VALUE>}
ucl/by-unid/<UNID>/ep0/FlowMeasurement/Attributes/MaxMeasuredValue/Reported { "value": <REPORTED_MAX_MEASURED_VALUE>}

\subsection flow_measurement_attr_tolerance FlowMeasurement/Tolerance Attribute

MQTT Topic Pattern:

[PREFIX]/FlowMeasurement/Attributes/Tolerance/Reported
[PREFIX]/FlowMeasurement/Attributes/Tolerance/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "FlowMeasurement Cluster Tolerance Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Tolerance attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/FlowMeasurement/Attributes/Tolerance/+'

# Example output

ucl/by-unid/<UNID>/ep0/FlowMeasurement/Attributes/Tolerance/Desired { "value": <DESIRED_TOLERANCE>}
ucl/by-unid/<UNID>/ep0/FlowMeasurement/Attributes/Tolerance/Reported { "value": <REPORTED_TOLERANCE>}

\subsection flow_measurement_attr_cluster_revision FlowMeasurement/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/FlowMeasurement/Attributes/ClusterRevision/Reported
[PREFIX]/FlowMeasurement/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "FlowMeasurement Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/FlowMeasurement/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/FlowMeasurement/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/FlowMeasurement/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section flow_measurement_recv_cmd_support FlowMeasurement Command Support

MQTT Topic Pattern:

[PREFIX]/FlowMeasurement/SupportedCommands
[PREFIX]/FlowMeasurement/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "FlowMeasurement Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for FlowMeasurement cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/FlowMeasurement/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/FlowMeasurement/SupportedCommands { "value": [] }

To see supported generated commands for FlowMeasurement cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/FlowMeasurement/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/FlowMeasurement/SupportedGeneratedCommands { "value": [] }

\section flow_measurement_cmds FlowMeasurement Commands

\subsection flow_measurement_write_attr_cmd FlowMeasurement/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/FlowMeasurement/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "FlowMeasurement Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all FlowMeasurement attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/FlowMeasurement/Commands/WriteAttributes' -m  '{  }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection flow_measurement_force_read_attr_cmd FlowMeasurement/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/FlowMeasurement/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "FlowMeasurement Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "MeasuredValue",
          "MinMeasuredValue",
          "MaxMeasuredValue",
          "Tolerance"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all FlowMeasurement attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/FlowMeasurement/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the FlowMeasurement attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/FlowMeasurement/Commands/ForceReadAttributes' -m  '{ "value": ["MeasuredValue"] }'

\page relativity_humidity RelativityHumidity Cluster The following commands and attributes are accepted as JSON payloads for the RelativityHumidity cluster.

\section relativity_humidity_attrs RelativityHumidity Attributes The following attribute topics are used to retrieve the RelativityHumidity cluster state.

\subsection relativity_humidity_attr_measured_value RelativityHumidity/MeasuredValue Attribute

MQTT Topic Pattern:

[PREFIX]/RelativityHumidity/Attributes/MeasuredValue/Reported
[PREFIX]/RelativityHumidity/Attributes/MeasuredValue/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "RelativityHumidity Cluster MeasuredValue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MeasuredValue attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/RelativityHumidity/Attributes/MeasuredValue/+'

# Example output

ucl/by-unid/<UNID>/ep0/RelativityHumidity/Attributes/MeasuredValue/Desired { "value": <DESIRED_MEASURED_VALUE>}
ucl/by-unid/<UNID>/ep0/RelativityHumidity/Attributes/MeasuredValue/Reported { "value": <REPORTED_MEASURED_VALUE>}

\subsection relativity_humidity_attr_min_measured_value RelativityHumidity/MinMeasuredValue Attribute

MQTT Topic Pattern:

[PREFIX]/RelativityHumidity/Attributes/MinMeasuredValue/Reported
[PREFIX]/RelativityHumidity/Attributes/MinMeasuredValue/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "RelativityHumidity Cluster MinMeasuredValue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MinMeasuredValue attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/RelativityHumidity/Attributes/MinMeasuredValue/+'

# Example output

ucl/by-unid/<UNID>/ep0/RelativityHumidity/Attributes/MinMeasuredValue/Desired { "value": <DESIRED_MIN_MEASURED_VALUE>}
ucl/by-unid/<UNID>/ep0/RelativityHumidity/Attributes/MinMeasuredValue/Reported { "value": <REPORTED_MIN_MEASURED_VALUE>}

\subsection relativity_humidity_attr_max_measured_value RelativityHumidity/MaxMeasuredValue Attribute

MQTT Topic Pattern:

[PREFIX]/RelativityHumidity/Attributes/MaxMeasuredValue/Reported
[PREFIX]/RelativityHumidity/Attributes/MaxMeasuredValue/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "RelativityHumidity Cluster MaxMeasuredValue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MaxMeasuredValue attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/RelativityHumidity/Attributes/MaxMeasuredValue/+'

# Example output

ucl/by-unid/<UNID>/ep0/RelativityHumidity/Attributes/MaxMeasuredValue/Desired { "value": <DESIRED_MAX_MEASURED_VALUE>}
ucl/by-unid/<UNID>/ep0/RelativityHumidity/Attributes/MaxMeasuredValue/Reported { "value": <REPORTED_MAX_MEASURED_VALUE>}

\subsection relativity_humidity_attr_tolerance RelativityHumidity/Tolerance Attribute

MQTT Topic Pattern:

[PREFIX]/RelativityHumidity/Attributes/Tolerance/Reported
[PREFIX]/RelativityHumidity/Attributes/Tolerance/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "RelativityHumidity Cluster Tolerance Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Tolerance attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/RelativityHumidity/Attributes/Tolerance/+'

# Example output

ucl/by-unid/<UNID>/ep0/RelativityHumidity/Attributes/Tolerance/Desired { "value": <DESIRED_TOLERANCE>}
ucl/by-unid/<UNID>/ep0/RelativityHumidity/Attributes/Tolerance/Reported { "value": <REPORTED_TOLERANCE>}

\subsection relativity_humidity_attr_cluster_revision RelativityHumidity/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/RelativityHumidity/Attributes/ClusterRevision/Reported
[PREFIX]/RelativityHumidity/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "RelativityHumidity Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/RelativityHumidity/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/RelativityHumidity/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/RelativityHumidity/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section relativity_humidity_recv_cmd_support RelativityHumidity Command Support

MQTT Topic Pattern:

[PREFIX]/RelativityHumidity/SupportedCommands
[PREFIX]/RelativityHumidity/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "RelativityHumidity Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for RelativityHumidity cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/RelativityHumidity/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/RelativityHumidity/SupportedCommands { "value": [] }

To see supported generated commands for RelativityHumidity cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/RelativityHumidity/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/RelativityHumidity/SupportedGeneratedCommands { "value": [] }

\section relativity_humidity_cmds RelativityHumidity Commands

\subsection relativity_humidity_write_attr_cmd RelativityHumidity/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/RelativityHumidity/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "RelativityHumidity Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all RelativityHumidity attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/RelativityHumidity/Commands/WriteAttributes' -m  '{  }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection relativity_humidity_force_read_attr_cmd RelativityHumidity/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/RelativityHumidity/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "RelativityHumidity Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "MeasuredValue",
          "MinMeasuredValue",
          "MaxMeasuredValue",
          "Tolerance"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all RelativityHumidity attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/RelativityHumidity/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the RelativityHumidity attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/RelativityHumidity/Commands/ForceReadAttributes' -m  '{ "value": ["MeasuredValue"] }'

\page occupancy_sensing OccupancySensing Cluster The following commands and attributes are accepted as JSON payloads for the OccupancySensing cluster.

\section occupancy_sensing_attrs OccupancySensing Attributes The following attribute topics are used to retrieve the OccupancySensing cluster state.

\subsection occupancy_sensing_attr_occupancy OccupancySensing/Occupancy Attribute

MQTT Topic Pattern:

[PREFIX]/OccupancySensing/Attributes/Occupancy/Reported
[PREFIX]/OccupancySensing/Attributes/Occupancy/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "OccupancySensing Cluster Occupancy Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "OccupancySensingOccupancy"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Occupancy attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/OccupancySensing/Attributes/Occupancy/+'

# Example output

ucl/by-unid/<UNID>/ep0/OccupancySensing/Attributes/Occupancy/Desired { "value": <DESIRED_OCCUPANCY>}
ucl/by-unid/<UNID>/ep0/OccupancySensing/Attributes/Occupancy/Reported { "value": <REPORTED_OCCUPANCY>}

\subsection occupancy_sensing_attr_occupancy_sensor_type OccupancySensing/OccupancySensorType Attribute

MQTT Topic Pattern:

[PREFIX]/OccupancySensing/Attributes/OccupancySensorType/Reported
[PREFIX]/OccupancySensing/Attributes/OccupancySensorType/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "OccupancySensing Cluster OccupancySensorType Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "OccupancySensingOccupancySensorType"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for OccupancySensorType attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/OccupancySensing/Attributes/OccupancySensorType/+'

# Example output

ucl/by-unid/<UNID>/ep0/OccupancySensing/Attributes/OccupancySensorType/Desired { "value": <DESIRED_OCCUPANCY_SENSOR_TYPE>}
ucl/by-unid/<UNID>/ep0/OccupancySensing/Attributes/OccupancySensorType/Reported { "value": <REPORTED_OCCUPANCY_SENSOR_TYPE>}

\subsection occupancy_sensing_attr_occupancy_sensor_type_bitmap OccupancySensing/OccupancySensorTypeBitmap Attribute

MQTT Topic Pattern:

[PREFIX]/OccupancySensing/Attributes/OccupancySensorTypeBitmap/Reported
[PREFIX]/OccupancySensing/Attributes/OccupancySensorTypeBitmap/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "OccupancySensing Cluster OccupancySensorTypeBitmap Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "OccupancySensingOccupancySensorTypeBitmap"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for OccupancySensorTypeBitmap attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/OccupancySensing/Attributes/OccupancySensorTypeBitmap/+'

# Example output

ucl/by-unid/<UNID>/ep0/OccupancySensing/Attributes/OccupancySensorTypeBitmap/Desired { "value": <DESIRED_OCCUPANCY_SENSOR_TYPE_BITMAP>}
ucl/by-unid/<UNID>/ep0/OccupancySensing/Attributes/OccupancySensorTypeBitmap/Reported { "value": <REPORTED_OCCUPANCY_SENSOR_TYPE_BITMAP>}

\subsection occupancy_sensing_attr_pir_occupied_to_unoccupied_delay OccupancySensing/PIROccupiedToUnoccupiedDelay Attribute

MQTT Topic Pattern:

[PREFIX]/OccupancySensing/Attributes/PIROccupiedToUnoccupiedDelay/Reported
[PREFIX]/OccupancySensing/Attributes/PIROccupiedToUnoccupiedDelay/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "OccupancySensing Cluster PIROccupiedToUnoccupiedDelay Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for PIROccupiedToUnoccupiedDelay attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/OccupancySensing/Attributes/PIROccupiedToUnoccupiedDelay/+'

# Example output

ucl/by-unid/<UNID>/ep0/OccupancySensing/Attributes/PIROccupiedToUnoccupiedDelay/Desired { "value": <DESIRED_PIR_OCCUPIED_TO_UNOCCUPIED_DELAY>}
ucl/by-unid/<UNID>/ep0/OccupancySensing/Attributes/PIROccupiedToUnoccupiedDelay/Reported { "value": <REPORTED_PIR_OCCUPIED_TO_UNOCCUPIED_DELAY>}

\subsection occupancy_sensing_attr_pir_unoccupied_to_occupied_delay OccupancySensing/PIRUnoccupiedToOccupiedDelay Attribute

MQTT Topic Pattern:

[PREFIX]/OccupancySensing/Attributes/PIRUnoccupiedToOccupiedDelay/Reported
[PREFIX]/OccupancySensing/Attributes/PIRUnoccupiedToOccupiedDelay/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "OccupancySensing Cluster PIRUnoccupiedToOccupiedDelay Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for PIRUnoccupiedToOccupiedDelay attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/OccupancySensing/Attributes/PIRUnoccupiedToOccupiedDelay/+'

# Example output

ucl/by-unid/<UNID>/ep0/OccupancySensing/Attributes/PIRUnoccupiedToOccupiedDelay/Desired { "value": <DESIRED_PIR_UNOCCUPIED_TO_OCCUPIED_DELAY>}
ucl/by-unid/<UNID>/ep0/OccupancySensing/Attributes/PIRUnoccupiedToOccupiedDelay/Reported { "value": <REPORTED_PIR_UNOCCUPIED_TO_OCCUPIED_DELAY>}

\subsection occupancy_sensing_attr_pir_unoccupied_to_occupied_threshold OccupancySensing/PIRUnoccupiedToOccupiedThreshold Attribute

MQTT Topic Pattern:

[PREFIX]/OccupancySensing/Attributes/PIRUnoccupiedToOccupiedThreshold/Reported
[PREFIX]/OccupancySensing/Attributes/PIRUnoccupiedToOccupiedThreshold/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "OccupancySensing Cluster PIRUnoccupiedToOccupiedThreshold Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for PIRUnoccupiedToOccupiedThreshold attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/OccupancySensing/Attributes/PIRUnoccupiedToOccupiedThreshold/+'

# Example output

ucl/by-unid/<UNID>/ep0/OccupancySensing/Attributes/PIRUnoccupiedToOccupiedThreshold/Desired { "value": <DESIRED_PIR_UNOCCUPIED_TO_OCCUPIED_THRESHOLD>}
ucl/by-unid/<UNID>/ep0/OccupancySensing/Attributes/PIRUnoccupiedToOccupiedThreshold/Reported { "value": <REPORTED_PIR_UNOCCUPIED_TO_OCCUPIED_THRESHOLD>}

\subsection occupancy_sensing_attr_ultrasonic_occupied_to_unoccupied_delay OccupancySensing/UltrasonicOccupiedToUnoccupiedDelay Attribute

MQTT Topic Pattern:

[PREFIX]/OccupancySensing/Attributes/UltrasonicOccupiedToUnoccupiedDelay/Reported
[PREFIX]/OccupancySensing/Attributes/UltrasonicOccupiedToUnoccupiedDelay/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "OccupancySensing Cluster UltrasonicOccupiedToUnoccupiedDelay Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for UltrasonicOccupiedToUnoccupiedDelay attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/OccupancySensing/Attributes/UltrasonicOccupiedToUnoccupiedDelay/+'

# Example output

ucl/by-unid/<UNID>/ep0/OccupancySensing/Attributes/UltrasonicOccupiedToUnoccupiedDelay/Desired { "value": <DESIRED_ULTRASONIC_OCCUPIED_TO_UNOCCUPIED_DELAY>}
ucl/by-unid/<UNID>/ep0/OccupancySensing/Attributes/UltrasonicOccupiedToUnoccupiedDelay/Reported { "value": <REPORTED_ULTRASONIC_OCCUPIED_TO_UNOCCUPIED_DELAY>}

\subsection occupancy_sensing_attr_ultrasonic_unoccupied_to_occupied_delay OccupancySensing/UltrasonicUnoccupiedToOccupiedDelay Attribute

MQTT Topic Pattern:

[PREFIX]/OccupancySensing/Attributes/UltrasonicUnoccupiedToOccupiedDelay/Reported
[PREFIX]/OccupancySensing/Attributes/UltrasonicUnoccupiedToOccupiedDelay/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "OccupancySensing Cluster UltrasonicUnoccupiedToOccupiedDelay Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for UltrasonicUnoccupiedToOccupiedDelay attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/OccupancySensing/Attributes/UltrasonicUnoccupiedToOccupiedDelay/+'

# Example output

ucl/by-unid/<UNID>/ep0/OccupancySensing/Attributes/UltrasonicUnoccupiedToOccupiedDelay/Desired { "value": <DESIRED_ULTRASONIC_UNOCCUPIED_TO_OCCUPIED_DELAY>}
ucl/by-unid/<UNID>/ep0/OccupancySensing/Attributes/UltrasonicUnoccupiedToOccupiedDelay/Reported { "value": <REPORTED_ULTRASONIC_UNOCCUPIED_TO_OCCUPIED_DELAY>}

\subsection occupancy_sensing_attr_ultrasonic_unoccupied_to_occupied_threshold OccupancySensing/UltrasonicUnoccupiedToOccupiedThreshold Attribute

MQTT Topic Pattern:

[PREFIX]/OccupancySensing/Attributes/UltrasonicUnoccupiedToOccupiedThreshold/Reported
[PREFIX]/OccupancySensing/Attributes/UltrasonicUnoccupiedToOccupiedThreshold/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "OccupancySensing Cluster UltrasonicUnoccupiedToOccupiedThreshold Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for UltrasonicUnoccupiedToOccupiedThreshold attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/OccupancySensing/Attributes/UltrasonicUnoccupiedToOccupiedThreshold/+'

# Example output

ucl/by-unid/<UNID>/ep0/OccupancySensing/Attributes/UltrasonicUnoccupiedToOccupiedThreshold/Desired { "value": <DESIRED_ULTRASONIC_UNOCCUPIED_TO_OCCUPIED_THRESHOLD>}
ucl/by-unid/<UNID>/ep0/OccupancySensing/Attributes/UltrasonicUnoccupiedToOccupiedThreshold/Reported { "value": <REPORTED_ULTRASONIC_UNOCCUPIED_TO_OCCUPIED_THRESHOLD>}

\subsection occupancy_sensing_attr_physical_contact_occupied_to_unoccupied_delay OccupancySensing/PhysicalContactOccupiedToUnoccupiedDelay Attribute

MQTT Topic Pattern:

[PREFIX]/OccupancySensing/Attributes/PhysicalContactOccupiedToUnoccupiedDelay/Reported
[PREFIX]/OccupancySensing/Attributes/PhysicalContactOccupiedToUnoccupiedDelay/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "OccupancySensing Cluster PhysicalContactOccupiedToUnoccupiedDelay Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for PhysicalContactOccupiedToUnoccupiedDelay attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/OccupancySensing/Attributes/PhysicalContactOccupiedToUnoccupiedDelay/+'

# Example output

ucl/by-unid/<UNID>/ep0/OccupancySensing/Attributes/PhysicalContactOccupiedToUnoccupiedDelay/Desired { "value": <DESIRED_PHYSICAL_CONTACT_OCCUPIED_TO_UNOCCUPIED_DELAY>}
ucl/by-unid/<UNID>/ep0/OccupancySensing/Attributes/PhysicalContactOccupiedToUnoccupiedDelay/Reported { "value": <REPORTED_PHYSICAL_CONTACT_OCCUPIED_TO_UNOCCUPIED_DELAY>}

\subsection occupancy_sensing_attr_physical_contact_unoccupied_to_occupied_delay OccupancySensing/PhysicalContactUnoccupiedToOccupiedDelay Attribute

MQTT Topic Pattern:

[PREFIX]/OccupancySensing/Attributes/PhysicalContactUnoccupiedToOccupiedDelay/Reported
[PREFIX]/OccupancySensing/Attributes/PhysicalContactUnoccupiedToOccupiedDelay/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "OccupancySensing Cluster PhysicalContactUnoccupiedToOccupiedDelay Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for PhysicalContactUnoccupiedToOccupiedDelay attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/OccupancySensing/Attributes/PhysicalContactUnoccupiedToOccupiedDelay/+'

# Example output

ucl/by-unid/<UNID>/ep0/OccupancySensing/Attributes/PhysicalContactUnoccupiedToOccupiedDelay/Desired { "value": <DESIRED_PHYSICAL_CONTACT_UNOCCUPIED_TO_OCCUPIED_DELAY>}
ucl/by-unid/<UNID>/ep0/OccupancySensing/Attributes/PhysicalContactUnoccupiedToOccupiedDelay/Reported { "value": <REPORTED_PHYSICAL_CONTACT_UNOCCUPIED_TO_OCCUPIED_DELAY>}

\subsection occupancy_sensing_attr_physical_contact_unoccupied_to_occupied_threshold OccupancySensing/PhysicalContactUnoccupiedToOccupiedThreshold Attribute

MQTT Topic Pattern:

[PREFIX]/OccupancySensing/Attributes/PhysicalContactUnoccupiedToOccupiedThreshold/Reported
[PREFIX]/OccupancySensing/Attributes/PhysicalContactUnoccupiedToOccupiedThreshold/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "OccupancySensing Cluster PhysicalContactUnoccupiedToOccupiedThreshold Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for PhysicalContactUnoccupiedToOccupiedThreshold attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/OccupancySensing/Attributes/PhysicalContactUnoccupiedToOccupiedThreshold/+'

# Example output

ucl/by-unid/<UNID>/ep0/OccupancySensing/Attributes/PhysicalContactUnoccupiedToOccupiedThreshold/Desired { "value": <DESIRED_PHYSICAL_CONTACT_UNOCCUPIED_TO_OCCUPIED_THRESHOLD>}
ucl/by-unid/<UNID>/ep0/OccupancySensing/Attributes/PhysicalContactUnoccupiedToOccupiedThreshold/Reported { "value": <REPORTED_PHYSICAL_CONTACT_UNOCCUPIED_TO_OCCUPIED_THRESHOLD>}

\subsection occupancy_sensing_attr_cluster_revision OccupancySensing/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/OccupancySensing/Attributes/ClusterRevision/Reported
[PREFIX]/OccupancySensing/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "OccupancySensing Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/OccupancySensing/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/OccupancySensing/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/OccupancySensing/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section occupancy_sensing_recv_cmd_support OccupancySensing Command Support

MQTT Topic Pattern:

[PREFIX]/OccupancySensing/SupportedCommands
[PREFIX]/OccupancySensing/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "OccupancySensing Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for OccupancySensing cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/OccupancySensing/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/OccupancySensing/SupportedCommands { "value": [] }

To see supported generated commands for OccupancySensing cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/OccupancySensing/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/OccupancySensing/SupportedGeneratedCommands { "value": [] }

\section occupancy_sensing_cmds OccupancySensing Commands

\subsection occupancy_sensing_write_attr_cmd OccupancySensing/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/OccupancySensing/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "OccupancySensing Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
    "PIROccupiedToUnoccupiedDelay": {
      "type": "integer"
    },
    "PIRUnoccupiedToOccupiedDelay": {
      "type": "integer"
    },
    "PIRUnoccupiedToOccupiedThreshold": {
      "type": "integer"
    },
    "UltrasonicOccupiedToUnoccupiedDelay": {
      "type": "integer"
    },
    "UltrasonicUnoccupiedToOccupiedDelay": {
      "type": "integer"
    },
    "UltrasonicUnoccupiedToOccupiedThreshold": {
      "type": "integer"
    },
    "PhysicalContactOccupiedToUnoccupiedDelay": {
      "type": "integer"
    },
    "PhysicalContactUnoccupiedToOccupiedDelay": {
      "type": "integer"
    },
    "PhysicalContactUnoccupiedToOccupiedThreshold": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all OccupancySensing attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/OccupancySensing/Commands/WriteAttributes' -m  '{ "PIROccupiedToUnoccupiedDelay": <PIR_OCCUPIED_TO_UNOCCUPIED_DELAY_VALUE> ,"PIRUnoccupiedToOccupiedDelay": <PIR_UNOCCUPIED_TO_OCCUPIED_DELAY_VALUE> ,"PIRUnoccupiedToOccupiedThreshold": <PIR_UNOCCUPIED_TO_OCCUPIED_THRESHOLD_VALUE> ,"UltrasonicOccupiedToUnoccupiedDelay": <ULTRASONIC_OCCUPIED_TO_UNOCCUPIED_DELAY_VALUE> ,"UltrasonicUnoccupiedToOccupiedDelay": <ULTRASONIC_UNOCCUPIED_TO_OCCUPIED_DELAY_VALUE> ,"UltrasonicUnoccupiedToOccupiedThreshold": <ULTRASONIC_UNOCCUPIED_TO_OCCUPIED_THRESHOLD_VALUE> ,"PhysicalContactOccupiedToUnoccupiedDelay": <PHYSICAL_CONTACT_OCCUPIED_TO_UNOCCUPIED_DELAY_VALUE> ,"PhysicalContactUnoccupiedToOccupiedDelay": <PHYSICAL_CONTACT_UNOCCUPIED_TO_OCCUPIED_DELAY_VALUE> ,"PhysicalContactUnoccupiedToOccupiedThreshold": <PHYSICAL_CONTACT_UNOCCUPIED_TO_OCCUPIED_THRESHOLD_VALUE>  }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection occupancy_sensing_force_read_attr_cmd OccupancySensing/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/OccupancySensing/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "OccupancySensing Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "Occupancy",
          "OccupancySensorType",
          "OccupancySensorTypeBitmap",
          "PIROccupiedToUnoccupiedDelay",
          "PIRUnoccupiedToOccupiedDelay",
          "PIRUnoccupiedToOccupiedThreshold",
          "UltrasonicOccupiedToUnoccupiedDelay",
          "UltrasonicUnoccupiedToOccupiedDelay",
          "UltrasonicUnoccupiedToOccupiedThreshold",
          "PhysicalContactOccupiedToUnoccupiedDelay",
          "PhysicalContactUnoccupiedToOccupiedDelay",
          "PhysicalContactUnoccupiedToOccupiedThreshold"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all OccupancySensing attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/OccupancySensing/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the OccupancySensing attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/OccupancySensing/Commands/ForceReadAttributes' -m  '{ "value": ["Occupancy"] }'

\page soil_moisture SoilMoisture Cluster The following commands and attributes are accepted as JSON payloads for the SoilMoisture cluster.

\section soil_moisture_attrs SoilMoisture Attributes The following attribute topics are used to retrieve the SoilMoisture cluster state.

\subsection soil_moisture_attr_measured_value SoilMoisture/MeasuredValue Attribute

MQTT Topic Pattern:

[PREFIX]/SoilMoisture/Attributes/MeasuredValue/Reported
[PREFIX]/SoilMoisture/Attributes/MeasuredValue/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SoilMoisture Cluster MeasuredValue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MeasuredValue attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/SoilMoisture/Attributes/MeasuredValue/+'

# Example output

ucl/by-unid/<UNID>/ep0/SoilMoisture/Attributes/MeasuredValue/Desired { "value": <DESIRED_MEASURED_VALUE>}
ucl/by-unid/<UNID>/ep0/SoilMoisture/Attributes/MeasuredValue/Reported { "value": <REPORTED_MEASURED_VALUE>}

\subsection soil_moisture_attr_min_measured_value SoilMoisture/MinMeasuredValue Attribute

MQTT Topic Pattern:

[PREFIX]/SoilMoisture/Attributes/MinMeasuredValue/Reported
[PREFIX]/SoilMoisture/Attributes/MinMeasuredValue/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SoilMoisture Cluster MinMeasuredValue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MinMeasuredValue attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/SoilMoisture/Attributes/MinMeasuredValue/+'

# Example output

ucl/by-unid/<UNID>/ep0/SoilMoisture/Attributes/MinMeasuredValue/Desired { "value": <DESIRED_MIN_MEASURED_VALUE>}
ucl/by-unid/<UNID>/ep0/SoilMoisture/Attributes/MinMeasuredValue/Reported { "value": <REPORTED_MIN_MEASURED_VALUE>}

\subsection soil_moisture_attr_max_measured_value SoilMoisture/MaxMeasuredValue Attribute

MQTT Topic Pattern:

[PREFIX]/SoilMoisture/Attributes/MaxMeasuredValue/Reported
[PREFIX]/SoilMoisture/Attributes/MaxMeasuredValue/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SoilMoisture Cluster MaxMeasuredValue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MaxMeasuredValue attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/SoilMoisture/Attributes/MaxMeasuredValue/+'

# Example output

ucl/by-unid/<UNID>/ep0/SoilMoisture/Attributes/MaxMeasuredValue/Desired { "value": <DESIRED_MAX_MEASURED_VALUE>}
ucl/by-unid/<UNID>/ep0/SoilMoisture/Attributes/MaxMeasuredValue/Reported { "value": <REPORTED_MAX_MEASURED_VALUE>}

\subsection soil_moisture_attr_tolerance SoilMoisture/Tolerance Attribute

MQTT Topic Pattern:

[PREFIX]/SoilMoisture/Attributes/Tolerance/Reported
[PREFIX]/SoilMoisture/Attributes/Tolerance/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SoilMoisture Cluster Tolerance Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Tolerance attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/SoilMoisture/Attributes/Tolerance/+'

# Example output

ucl/by-unid/<UNID>/ep0/SoilMoisture/Attributes/Tolerance/Desired { "value": <DESIRED_TOLERANCE>}
ucl/by-unid/<UNID>/ep0/SoilMoisture/Attributes/Tolerance/Reported { "value": <REPORTED_TOLERANCE>}

\subsection soil_moisture_attr_cluster_revision SoilMoisture/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/SoilMoisture/Attributes/ClusterRevision/Reported
[PREFIX]/SoilMoisture/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SoilMoisture Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/SoilMoisture/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/SoilMoisture/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/SoilMoisture/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section soil_moisture_recv_cmd_support SoilMoisture Command Support

MQTT Topic Pattern:

[PREFIX]/SoilMoisture/SupportedCommands
[PREFIX]/SoilMoisture/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SoilMoisture Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for SoilMoisture cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/SoilMoisture/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/SoilMoisture/SupportedCommands { "value": [] }

To see supported generated commands for SoilMoisture cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/SoilMoisture/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/SoilMoisture/SupportedGeneratedCommands { "value": [] }

\section soil_moisture_cmds SoilMoisture Commands

\subsection soil_moisture_write_attr_cmd SoilMoisture/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/SoilMoisture/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SoilMoisture Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all SoilMoisture attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/SoilMoisture/Commands/WriteAttributes' -m  '{  }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection soil_moisture_force_read_attr_cmd SoilMoisture/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/SoilMoisture/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SoilMoisture Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "MeasuredValue",
          "MinMeasuredValue",
          "MaxMeasuredValue",
          "Tolerance"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all SoilMoisture attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/SoilMoisture/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the SoilMoisture attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/SoilMoisture/Commands/ForceReadAttributes' -m  '{ "value": ["MeasuredValue"] }'

\page ph_measurement PhMeasurement Cluster The following commands and attributes are accepted as JSON payloads for the PhMeasurement cluster.

\section ph_measurement_attrs PhMeasurement Attributes The following attribute topics are used to retrieve the PhMeasurement cluster state.

\subsection ph_measurement_attr_measured_value PhMeasurement/MeasuredValue Attribute

MQTT Topic Pattern:

[PREFIX]/PhMeasurement/Attributes/MeasuredValue/Reported
[PREFIX]/PhMeasurement/Attributes/MeasuredValue/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PhMeasurement Cluster MeasuredValue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MeasuredValue attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PhMeasurement/Attributes/MeasuredValue/+'

# Example output

ucl/by-unid/<UNID>/ep0/PhMeasurement/Attributes/MeasuredValue/Desired { "value": <DESIRED_MEASURED_VALUE>}
ucl/by-unid/<UNID>/ep0/PhMeasurement/Attributes/MeasuredValue/Reported { "value": <REPORTED_MEASURED_VALUE>}

\subsection ph_measurement_attr_min_measured_value PhMeasurement/MinMeasuredValue Attribute

MQTT Topic Pattern:

[PREFIX]/PhMeasurement/Attributes/MinMeasuredValue/Reported
[PREFIX]/PhMeasurement/Attributes/MinMeasuredValue/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PhMeasurement Cluster MinMeasuredValue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MinMeasuredValue attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PhMeasurement/Attributes/MinMeasuredValue/+'

# Example output

ucl/by-unid/<UNID>/ep0/PhMeasurement/Attributes/MinMeasuredValue/Desired { "value": <DESIRED_MIN_MEASURED_VALUE>}
ucl/by-unid/<UNID>/ep0/PhMeasurement/Attributes/MinMeasuredValue/Reported { "value": <REPORTED_MIN_MEASURED_VALUE>}

\subsection ph_measurement_attr_max_measured_value PhMeasurement/MaxMeasuredValue Attribute

MQTT Topic Pattern:

[PREFIX]/PhMeasurement/Attributes/MaxMeasuredValue/Reported
[PREFIX]/PhMeasurement/Attributes/MaxMeasuredValue/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PhMeasurement Cluster MaxMeasuredValue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MaxMeasuredValue attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PhMeasurement/Attributes/MaxMeasuredValue/+'

# Example output

ucl/by-unid/<UNID>/ep0/PhMeasurement/Attributes/MaxMeasuredValue/Desired { "value": <DESIRED_MAX_MEASURED_VALUE>}
ucl/by-unid/<UNID>/ep0/PhMeasurement/Attributes/MaxMeasuredValue/Reported { "value": <REPORTED_MAX_MEASURED_VALUE>}

\subsection ph_measurement_attr_tolerance PhMeasurement/Tolerance Attribute

MQTT Topic Pattern:

[PREFIX]/PhMeasurement/Attributes/Tolerance/Reported
[PREFIX]/PhMeasurement/Attributes/Tolerance/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PhMeasurement Cluster Tolerance Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Tolerance attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PhMeasurement/Attributes/Tolerance/+'

# Example output

ucl/by-unid/<UNID>/ep0/PhMeasurement/Attributes/Tolerance/Desired { "value": <DESIRED_TOLERANCE>}
ucl/by-unid/<UNID>/ep0/PhMeasurement/Attributes/Tolerance/Reported { "value": <REPORTED_TOLERANCE>}

\subsection ph_measurement_attr_cluster_revision PhMeasurement/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/PhMeasurement/Attributes/ClusterRevision/Reported
[PREFIX]/PhMeasurement/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PhMeasurement Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/PhMeasurement/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/PhMeasurement/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/PhMeasurement/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section ph_measurement_recv_cmd_support PhMeasurement Command Support

MQTT Topic Pattern:

[PREFIX]/PhMeasurement/SupportedCommands
[PREFIX]/PhMeasurement/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PhMeasurement Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for PhMeasurement cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/PhMeasurement/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/PhMeasurement/SupportedCommands { "value": [] }

To see supported generated commands for PhMeasurement cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/PhMeasurement/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/PhMeasurement/SupportedGeneratedCommands { "value": [] }

\section ph_measurement_cmds PhMeasurement Commands

\subsection ph_measurement_write_attr_cmd PhMeasurement/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/PhMeasurement/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PhMeasurement Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all PhMeasurement attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/PhMeasurement/Commands/WriteAttributes' -m  '{  }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection ph_measurement_force_read_attr_cmd PhMeasurement/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/PhMeasurement/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PhMeasurement Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "MeasuredValue",
          "MinMeasuredValue",
          "MaxMeasuredValue",
          "Tolerance"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all PhMeasurement attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/PhMeasurement/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the PhMeasurement attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/PhMeasurement/Commands/ForceReadAttributes' -m  '{ "value": ["MeasuredValue"] }'

\page electrical_conductivity_measurement ElectricalConductivityMeasurement Cluster The following commands and attributes are accepted as JSON payloads for the ElectricalConductivityMeasurement cluster.

\section electrical_conductivity_measurement_attrs ElectricalConductivityMeasurement Attributes The following attribute topics are used to retrieve the ElectricalConductivityMeasurement cluster state.

\subsection electrical_conductivity_measurement_attr_measured_value ElectricalConductivityMeasurement/MeasuredValue Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalConductivityMeasurement/Attributes/MeasuredValue/Reported
[PREFIX]/ElectricalConductivityMeasurement/Attributes/MeasuredValue/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalConductivityMeasurement Cluster MeasuredValue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MeasuredValue attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalConductivityMeasurement/Attributes/MeasuredValue/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalConductivityMeasurement/Attributes/MeasuredValue/Desired { "value": <DESIRED_MEASURED_VALUE>}
ucl/by-unid/<UNID>/ep0/ElectricalConductivityMeasurement/Attributes/MeasuredValue/Reported { "value": <REPORTED_MEASURED_VALUE>}

\subsection electrical_conductivity_measurement_attr_min_measured_value ElectricalConductivityMeasurement/MinMeasuredValue Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalConductivityMeasurement/Attributes/MinMeasuredValue/Reported
[PREFIX]/ElectricalConductivityMeasurement/Attributes/MinMeasuredValue/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalConductivityMeasurement Cluster MinMeasuredValue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MinMeasuredValue attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalConductivityMeasurement/Attributes/MinMeasuredValue/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalConductivityMeasurement/Attributes/MinMeasuredValue/Desired { "value": <DESIRED_MIN_MEASURED_VALUE>}
ucl/by-unid/<UNID>/ep0/ElectricalConductivityMeasurement/Attributes/MinMeasuredValue/Reported { "value": <REPORTED_MIN_MEASURED_VALUE>}

\subsection electrical_conductivity_measurement_attr_max_measured_value ElectricalConductivityMeasurement/MaxMeasuredValue Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalConductivityMeasurement/Attributes/MaxMeasuredValue/Reported
[PREFIX]/ElectricalConductivityMeasurement/Attributes/MaxMeasuredValue/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalConductivityMeasurement Cluster MaxMeasuredValue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MaxMeasuredValue attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalConductivityMeasurement/Attributes/MaxMeasuredValue/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalConductivityMeasurement/Attributes/MaxMeasuredValue/Desired { "value": <DESIRED_MAX_MEASURED_VALUE>}
ucl/by-unid/<UNID>/ep0/ElectricalConductivityMeasurement/Attributes/MaxMeasuredValue/Reported { "value": <REPORTED_MAX_MEASURED_VALUE>}

\subsection electrical_conductivity_measurement_attr_tolerance ElectricalConductivityMeasurement/Tolerance Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalConductivityMeasurement/Attributes/Tolerance/Reported
[PREFIX]/ElectricalConductivityMeasurement/Attributes/Tolerance/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalConductivityMeasurement Cluster Tolerance Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Tolerance attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalConductivityMeasurement/Attributes/Tolerance/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalConductivityMeasurement/Attributes/Tolerance/Desired { "value": <DESIRED_TOLERANCE>}
ucl/by-unid/<UNID>/ep0/ElectricalConductivityMeasurement/Attributes/Tolerance/Reported { "value": <REPORTED_TOLERANCE>}

\subsection electrical_conductivity_measurement_attr_cluster_revision ElectricalConductivityMeasurement/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalConductivityMeasurement/Attributes/ClusterRevision/Reported
[PREFIX]/ElectricalConductivityMeasurement/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalConductivityMeasurement Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ElectricalConductivityMeasurement/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/ElectricalConductivityMeasurement/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/ElectricalConductivityMeasurement/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section electrical_conductivity_measurement_recv_cmd_support ElectricalConductivityMeasurement Command Support

MQTT Topic Pattern:

[PREFIX]/ElectricalConductivityMeasurement/SupportedCommands
[PREFIX]/ElectricalConductivityMeasurement/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalConductivityMeasurement Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for ElectricalConductivityMeasurement cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ElectricalConductivityMeasurement/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/ElectricalConductivityMeasurement/SupportedCommands { "value": [] }

To see supported generated commands for ElectricalConductivityMeasurement cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ElectricalConductivityMeasurement/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/ElectricalConductivityMeasurement/SupportedGeneratedCommands { "value": [] }

\section electrical_conductivity_measurement_cmds ElectricalConductivityMeasurement Commands

\subsection electrical_conductivity_measurement_write_attr_cmd ElectricalConductivityMeasurement/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/ElectricalConductivityMeasurement/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalConductivityMeasurement Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all ElectricalConductivityMeasurement attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ElectricalConductivityMeasurement/Commands/WriteAttributes' -m  '{  }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection electrical_conductivity_measurement_force_read_attr_cmd ElectricalConductivityMeasurement/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/ElectricalConductivityMeasurement/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalConductivityMeasurement Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "MeasuredValue",
          "MinMeasuredValue",
          "MaxMeasuredValue",
          "Tolerance"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all ElectricalConductivityMeasurement attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ElectricalConductivityMeasurement/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the ElectricalConductivityMeasurement attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ElectricalConductivityMeasurement/Commands/ForceReadAttributes' -m  '{ "value": ["MeasuredValue"] }'

\page wind_speed_measurement WindSpeedMeasurement Cluster The following commands and attributes are accepted as JSON payloads for the WindSpeedMeasurement cluster.

\section wind_speed_measurement_attrs WindSpeedMeasurement Attributes The following attribute topics are used to retrieve the WindSpeedMeasurement cluster state.

\subsection wind_speed_measurement_attr_measured_value WindSpeedMeasurement/MeasuredValue Attribute

MQTT Topic Pattern:

[PREFIX]/WindSpeedMeasurement/Attributes/MeasuredValue/Reported
[PREFIX]/WindSpeedMeasurement/Attributes/MeasuredValue/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindSpeedMeasurement Cluster MeasuredValue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MeasuredValue attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/WindSpeedMeasurement/Attributes/MeasuredValue/+'

# Example output

ucl/by-unid/<UNID>/ep0/WindSpeedMeasurement/Attributes/MeasuredValue/Desired { "value": <DESIRED_MEASURED_VALUE>}
ucl/by-unid/<UNID>/ep0/WindSpeedMeasurement/Attributes/MeasuredValue/Reported { "value": <REPORTED_MEASURED_VALUE>}

\subsection wind_speed_measurement_attr_min_measured_value WindSpeedMeasurement/MinMeasuredValue Attribute

MQTT Topic Pattern:

[PREFIX]/WindSpeedMeasurement/Attributes/MinMeasuredValue/Reported
[PREFIX]/WindSpeedMeasurement/Attributes/MinMeasuredValue/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindSpeedMeasurement Cluster MinMeasuredValue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MinMeasuredValue attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/WindSpeedMeasurement/Attributes/MinMeasuredValue/+'

# Example output

ucl/by-unid/<UNID>/ep0/WindSpeedMeasurement/Attributes/MinMeasuredValue/Desired { "value": <DESIRED_MIN_MEASURED_VALUE>}
ucl/by-unid/<UNID>/ep0/WindSpeedMeasurement/Attributes/MinMeasuredValue/Reported { "value": <REPORTED_MIN_MEASURED_VALUE>}

\subsection wind_speed_measurement_attr_max_measured_value WindSpeedMeasurement/MaxMeasuredValue Attribute

MQTT Topic Pattern:

[PREFIX]/WindSpeedMeasurement/Attributes/MaxMeasuredValue/Reported
[PREFIX]/WindSpeedMeasurement/Attributes/MaxMeasuredValue/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindSpeedMeasurement Cluster MaxMeasuredValue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MaxMeasuredValue attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/WindSpeedMeasurement/Attributes/MaxMeasuredValue/+'

# Example output

ucl/by-unid/<UNID>/ep0/WindSpeedMeasurement/Attributes/MaxMeasuredValue/Desired { "value": <DESIRED_MAX_MEASURED_VALUE>}
ucl/by-unid/<UNID>/ep0/WindSpeedMeasurement/Attributes/MaxMeasuredValue/Reported { "value": <REPORTED_MAX_MEASURED_VALUE>}

\subsection wind_speed_measurement_attr_tolerance WindSpeedMeasurement/Tolerance Attribute

MQTT Topic Pattern:

[PREFIX]/WindSpeedMeasurement/Attributes/Tolerance/Reported
[PREFIX]/WindSpeedMeasurement/Attributes/Tolerance/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindSpeedMeasurement Cluster Tolerance Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Tolerance attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/WindSpeedMeasurement/Attributes/Tolerance/+'

# Example output

ucl/by-unid/<UNID>/ep0/WindSpeedMeasurement/Attributes/Tolerance/Desired { "value": <DESIRED_TOLERANCE>}
ucl/by-unid/<UNID>/ep0/WindSpeedMeasurement/Attributes/Tolerance/Reported { "value": <REPORTED_TOLERANCE>}

\subsection wind_speed_measurement_attr_cluster_revision WindSpeedMeasurement/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/WindSpeedMeasurement/Attributes/ClusterRevision/Reported
[PREFIX]/WindSpeedMeasurement/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindSpeedMeasurement Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/WindSpeedMeasurement/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/WindSpeedMeasurement/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/WindSpeedMeasurement/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section wind_speed_measurement_recv_cmd_support WindSpeedMeasurement Command Support

MQTT Topic Pattern:

[PREFIX]/WindSpeedMeasurement/SupportedCommands
[PREFIX]/WindSpeedMeasurement/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindSpeedMeasurement Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for WindSpeedMeasurement cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/WindSpeedMeasurement/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/WindSpeedMeasurement/SupportedCommands { "value": [] }

To see supported generated commands for WindSpeedMeasurement cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/WindSpeedMeasurement/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/WindSpeedMeasurement/SupportedGeneratedCommands { "value": [] }

\section wind_speed_measurement_cmds WindSpeedMeasurement Commands

\subsection wind_speed_measurement_write_attr_cmd WindSpeedMeasurement/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/WindSpeedMeasurement/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindSpeedMeasurement Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all WindSpeedMeasurement attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/WindSpeedMeasurement/Commands/WriteAttributes' -m  '{  }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection wind_speed_measurement_force_read_attr_cmd WindSpeedMeasurement/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/WindSpeedMeasurement/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindSpeedMeasurement Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "MeasuredValue",
          "MinMeasuredValue",
          "MaxMeasuredValue",
          "Tolerance"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all WindSpeedMeasurement attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/WindSpeedMeasurement/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the WindSpeedMeasurement attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/WindSpeedMeasurement/Commands/ForceReadAttributes' -m  '{ "value": ["MeasuredValue"] }'

\page carbon_monoxide CarbonMonoxide Cluster The following commands and attributes are accepted as JSON payloads for the CarbonMonoxide cluster.

\section carbon_monoxide_attrs CarbonMonoxide Attributes The following attribute topics are used to retrieve the CarbonMonoxide cluster state.

\subsection carbon_monoxide_attr_measured_value CarbonMonoxide/MeasuredValue Attribute

MQTT Topic Pattern:

[PREFIX]/CarbonMonoxide/Attributes/MeasuredValue/Reported
[PREFIX]/CarbonMonoxide/Attributes/MeasuredValue/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CarbonMonoxide Cluster MeasuredValue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MeasuredValue attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/CarbonMonoxide/Attributes/MeasuredValue/+'

# Example output

ucl/by-unid/<UNID>/ep0/CarbonMonoxide/Attributes/MeasuredValue/Desired { "value": <DESIRED_MEASURED_VALUE>}
ucl/by-unid/<UNID>/ep0/CarbonMonoxide/Attributes/MeasuredValue/Reported { "value": <REPORTED_MEASURED_VALUE>}

\subsection carbon_monoxide_attr_min_measured_value CarbonMonoxide/MinMeasuredValue Attribute

MQTT Topic Pattern:

[PREFIX]/CarbonMonoxide/Attributes/MinMeasuredValue/Reported
[PREFIX]/CarbonMonoxide/Attributes/MinMeasuredValue/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CarbonMonoxide Cluster MinMeasuredValue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MinMeasuredValue attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/CarbonMonoxide/Attributes/MinMeasuredValue/+'

# Example output

ucl/by-unid/<UNID>/ep0/CarbonMonoxide/Attributes/MinMeasuredValue/Desired { "value": <DESIRED_MIN_MEASURED_VALUE>}
ucl/by-unid/<UNID>/ep0/CarbonMonoxide/Attributes/MinMeasuredValue/Reported { "value": <REPORTED_MIN_MEASURED_VALUE>}

\subsection carbon_monoxide_attr_max_measured_value CarbonMonoxide/MaxMeasuredValue Attribute

MQTT Topic Pattern:

[PREFIX]/CarbonMonoxide/Attributes/MaxMeasuredValue/Reported
[PREFIX]/CarbonMonoxide/Attributes/MaxMeasuredValue/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CarbonMonoxide Cluster MaxMeasuredValue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MaxMeasuredValue attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/CarbonMonoxide/Attributes/MaxMeasuredValue/+'

# Example output

ucl/by-unid/<UNID>/ep0/CarbonMonoxide/Attributes/MaxMeasuredValue/Desired { "value": <DESIRED_MAX_MEASURED_VALUE>}
ucl/by-unid/<UNID>/ep0/CarbonMonoxide/Attributes/MaxMeasuredValue/Reported { "value": <REPORTED_MAX_MEASURED_VALUE>}

\subsection carbon_monoxide_attr_tolerance CarbonMonoxide/Tolerance Attribute

MQTT Topic Pattern:

[PREFIX]/CarbonMonoxide/Attributes/Tolerance/Reported
[PREFIX]/CarbonMonoxide/Attributes/Tolerance/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CarbonMonoxide Cluster Tolerance Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Tolerance attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/CarbonMonoxide/Attributes/Tolerance/+'

# Example output

ucl/by-unid/<UNID>/ep0/CarbonMonoxide/Attributes/Tolerance/Desired { "value": <DESIRED_TOLERANCE>}
ucl/by-unid/<UNID>/ep0/CarbonMonoxide/Attributes/Tolerance/Reported { "value": <REPORTED_TOLERANCE>}

\subsection carbon_monoxide_attr_cluster_revision CarbonMonoxide/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/CarbonMonoxide/Attributes/ClusterRevision/Reported
[PREFIX]/CarbonMonoxide/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CarbonMonoxide Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/CarbonMonoxide/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/CarbonMonoxide/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/CarbonMonoxide/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section carbon_monoxide_recv_cmd_support CarbonMonoxide Command Support

MQTT Topic Pattern:

[PREFIX]/CarbonMonoxide/SupportedCommands
[PREFIX]/CarbonMonoxide/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CarbonMonoxide Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for CarbonMonoxide cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/CarbonMonoxide/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/CarbonMonoxide/SupportedCommands { "value": [] }

To see supported generated commands for CarbonMonoxide cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/CarbonMonoxide/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/CarbonMonoxide/SupportedGeneratedCommands { "value": [] }

\section carbon_monoxide_cmds CarbonMonoxide Commands

\subsection carbon_monoxide_write_attr_cmd CarbonMonoxide/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/CarbonMonoxide/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CarbonMonoxide Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all CarbonMonoxide attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/CarbonMonoxide/Commands/WriteAttributes' -m  '{  }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection carbon_monoxide_force_read_attr_cmd CarbonMonoxide/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/CarbonMonoxide/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CarbonMonoxide Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "MeasuredValue",
          "MinMeasuredValue",
          "MaxMeasuredValue",
          "Tolerance"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all CarbonMonoxide attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/CarbonMonoxide/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the CarbonMonoxide attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/CarbonMonoxide/Commands/ForceReadAttributes' -m  '{ "value": ["MeasuredValue"] }'

\page carbon_dioxide CarbonDioxide Cluster The following commands and attributes are accepted as JSON payloads for the CarbonDioxide cluster.

\section carbon_dioxide_attrs CarbonDioxide Attributes The following attribute topics are used to retrieve the CarbonDioxide cluster state.

\subsection carbon_dioxide_attr_measured_value CarbonDioxide/MeasuredValue Attribute

MQTT Topic Pattern:

[PREFIX]/CarbonDioxide/Attributes/MeasuredValue/Reported
[PREFIX]/CarbonDioxide/Attributes/MeasuredValue/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CarbonDioxide Cluster MeasuredValue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MeasuredValue attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/CarbonDioxide/Attributes/MeasuredValue/+'

# Example output

ucl/by-unid/<UNID>/ep0/CarbonDioxide/Attributes/MeasuredValue/Desired { "value": <DESIRED_MEASURED_VALUE>}
ucl/by-unid/<UNID>/ep0/CarbonDioxide/Attributes/MeasuredValue/Reported { "value": <REPORTED_MEASURED_VALUE>}

\subsection carbon_dioxide_attr_min_measured_value CarbonDioxide/MinMeasuredValue Attribute

MQTT Topic Pattern:

[PREFIX]/CarbonDioxide/Attributes/MinMeasuredValue/Reported
[PREFIX]/CarbonDioxide/Attributes/MinMeasuredValue/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CarbonDioxide Cluster MinMeasuredValue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MinMeasuredValue attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/CarbonDioxide/Attributes/MinMeasuredValue/+'

# Example output

ucl/by-unid/<UNID>/ep0/CarbonDioxide/Attributes/MinMeasuredValue/Desired { "value": <DESIRED_MIN_MEASURED_VALUE>}
ucl/by-unid/<UNID>/ep0/CarbonDioxide/Attributes/MinMeasuredValue/Reported { "value": <REPORTED_MIN_MEASURED_VALUE>}

\subsection carbon_dioxide_attr_max_measured_value CarbonDioxide/MaxMeasuredValue Attribute

MQTT Topic Pattern:

[PREFIX]/CarbonDioxide/Attributes/MaxMeasuredValue/Reported
[PREFIX]/CarbonDioxide/Attributes/MaxMeasuredValue/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CarbonDioxide Cluster MaxMeasuredValue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MaxMeasuredValue attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/CarbonDioxide/Attributes/MaxMeasuredValue/+'

# Example output

ucl/by-unid/<UNID>/ep0/CarbonDioxide/Attributes/MaxMeasuredValue/Desired { "value": <DESIRED_MAX_MEASURED_VALUE>}
ucl/by-unid/<UNID>/ep0/CarbonDioxide/Attributes/MaxMeasuredValue/Reported { "value": <REPORTED_MAX_MEASURED_VALUE>}

\subsection carbon_dioxide_attr_tolerance CarbonDioxide/Tolerance Attribute

MQTT Topic Pattern:

[PREFIX]/CarbonDioxide/Attributes/Tolerance/Reported
[PREFIX]/CarbonDioxide/Attributes/Tolerance/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CarbonDioxide Cluster Tolerance Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Tolerance attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/CarbonDioxide/Attributes/Tolerance/+'

# Example output

ucl/by-unid/<UNID>/ep0/CarbonDioxide/Attributes/Tolerance/Desired { "value": <DESIRED_TOLERANCE>}
ucl/by-unid/<UNID>/ep0/CarbonDioxide/Attributes/Tolerance/Reported { "value": <REPORTED_TOLERANCE>}

\subsection carbon_dioxide_attr_cluster_revision CarbonDioxide/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/CarbonDioxide/Attributes/ClusterRevision/Reported
[PREFIX]/CarbonDioxide/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CarbonDioxide Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/CarbonDioxide/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/CarbonDioxide/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/CarbonDioxide/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section carbon_dioxide_recv_cmd_support CarbonDioxide Command Support

MQTT Topic Pattern:

[PREFIX]/CarbonDioxide/SupportedCommands
[PREFIX]/CarbonDioxide/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CarbonDioxide Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for CarbonDioxide cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/CarbonDioxide/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/CarbonDioxide/SupportedCommands { "value": [] }

To see supported generated commands for CarbonDioxide cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/CarbonDioxide/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/CarbonDioxide/SupportedGeneratedCommands { "value": [] }

\section carbon_dioxide_cmds CarbonDioxide Commands

\subsection carbon_dioxide_write_attr_cmd CarbonDioxide/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/CarbonDioxide/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CarbonDioxide Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all CarbonDioxide attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/CarbonDioxide/Commands/WriteAttributes' -m  '{  }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection carbon_dioxide_force_read_attr_cmd CarbonDioxide/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/CarbonDioxide/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CarbonDioxide Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "MeasuredValue",
          "MinMeasuredValue",
          "MaxMeasuredValue",
          "Tolerance"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all CarbonDioxide attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/CarbonDioxide/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the CarbonDioxide attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/CarbonDioxide/Commands/ForceReadAttributes' -m  '{ "value": ["MeasuredValue"] }'

\page pm25 PM25 Cluster The following commands and attributes are accepted as JSON payloads for the PM25 cluster.

\section pm25_attrs PM25 Attributes The following attribute topics are used to retrieve the PM25 cluster state.

\subsection pm25_attr_measured_value PM25/MeasuredValue Attribute

MQTT Topic Pattern:

[PREFIX]/PM25/Attributes/MeasuredValue/Reported
[PREFIX]/PM25/Attributes/MeasuredValue/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PM25 Cluster MeasuredValue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MeasuredValue attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PM25/Attributes/MeasuredValue/+'

# Example output

ucl/by-unid/<UNID>/ep0/PM25/Attributes/MeasuredValue/Desired { "value": <DESIRED_MEASURED_VALUE>}
ucl/by-unid/<UNID>/ep0/PM25/Attributes/MeasuredValue/Reported { "value": <REPORTED_MEASURED_VALUE>}

\subsection pm25_attr_min_measured_value PM25/MinMeasuredValue Attribute

MQTT Topic Pattern:

[PREFIX]/PM25/Attributes/MinMeasuredValue/Reported
[PREFIX]/PM25/Attributes/MinMeasuredValue/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PM25 Cluster MinMeasuredValue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MinMeasuredValue attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PM25/Attributes/MinMeasuredValue/+'

# Example output

ucl/by-unid/<UNID>/ep0/PM25/Attributes/MinMeasuredValue/Desired { "value": <DESIRED_MIN_MEASURED_VALUE>}
ucl/by-unid/<UNID>/ep0/PM25/Attributes/MinMeasuredValue/Reported { "value": <REPORTED_MIN_MEASURED_VALUE>}

\subsection pm25_attr_max_measured_value PM25/MaxMeasuredValue Attribute

MQTT Topic Pattern:

[PREFIX]/PM25/Attributes/MaxMeasuredValue/Reported
[PREFIX]/PM25/Attributes/MaxMeasuredValue/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PM25 Cluster MaxMeasuredValue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MaxMeasuredValue attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PM25/Attributes/MaxMeasuredValue/+'

# Example output

ucl/by-unid/<UNID>/ep0/PM25/Attributes/MaxMeasuredValue/Desired { "value": <DESIRED_MAX_MEASURED_VALUE>}
ucl/by-unid/<UNID>/ep0/PM25/Attributes/MaxMeasuredValue/Reported { "value": <REPORTED_MAX_MEASURED_VALUE>}

\subsection pm25_attr_tolerance PM25/Tolerance Attribute

MQTT Topic Pattern:

[PREFIX]/PM25/Attributes/Tolerance/Reported
[PREFIX]/PM25/Attributes/Tolerance/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PM25 Cluster Tolerance Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Tolerance attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/PM25/Attributes/Tolerance/+'

# Example output

ucl/by-unid/<UNID>/ep0/PM25/Attributes/Tolerance/Desired { "value": <DESIRED_TOLERANCE>}
ucl/by-unid/<UNID>/ep0/PM25/Attributes/Tolerance/Reported { "value": <REPORTED_TOLERANCE>}

\subsection pm25_attr_cluster_revision PM25/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/PM25/Attributes/ClusterRevision/Reported
[PREFIX]/PM25/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PM25 Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/PM25/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/PM25/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/PM25/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section pm25_recv_cmd_support PM25 Command Support

MQTT Topic Pattern:

[PREFIX]/PM25/SupportedCommands
[PREFIX]/PM25/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PM25 Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for PM25 cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/PM25/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/PM25/SupportedCommands { "value": [] }

To see supported generated commands for PM25 cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/PM25/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/PM25/SupportedGeneratedCommands { "value": [] }

\section pm25_cmds PM25 Commands

\subsection pm25_write_attr_cmd PM25/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/PM25/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PM25 Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all PM25 attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/PM25/Commands/WriteAttributes' -m  '{  }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection pm25_force_read_attr_cmd PM25/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/PM25/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PM25 Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "MeasuredValue",
          "MinMeasuredValue",
          "MaxMeasuredValue",
          "Tolerance"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all PM25 attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/PM25/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the PM25 attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/PM25/Commands/ForceReadAttributes' -m  '{ "value": ["MeasuredValue"] }'

\page ias_zone IASZone Cluster The following commands and attributes are accepted as JSON payloads for the IASZone cluster.

\section ias_zone_attrs IASZone Attributes The following attribute topics are used to retrieve the IASZone cluster state.

\subsection ias_zone_attr_zone_state IASZone/ZoneState Attribute

MQTT Topic Pattern:

[PREFIX]/IASZone/Attributes/ZoneState/Reported
[PREFIX]/IASZone/Attributes/ZoneState/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IASZone Cluster ZoneState Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "IASZoneZoneState"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ZoneState attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/IASZone/Attributes/ZoneState/+'

# Example output

ucl/by-unid/<UNID>/ep0/IASZone/Attributes/ZoneState/Desired { "value": <DESIRED_ZONE_STATE>}
ucl/by-unid/<UNID>/ep0/IASZone/Attributes/ZoneState/Reported { "value": <REPORTED_ZONE_STATE>}

\subsection ias_zone_attr_zone_type IASZone/ZoneType Attribute

MQTT Topic Pattern:

[PREFIX]/IASZone/Attributes/ZoneType/Reported
[PREFIX]/IASZone/Attributes/ZoneType/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IASZone Cluster ZoneType Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "IasZoneType"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ZoneType attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/IASZone/Attributes/ZoneType/+'

# Example output

ucl/by-unid/<UNID>/ep0/IASZone/Attributes/ZoneType/Desired { "value": <DESIRED_ZONE_TYPE>}
ucl/by-unid/<UNID>/ep0/IASZone/Attributes/ZoneType/Reported { "value": <REPORTED_ZONE_TYPE>}

\subsection ias_zone_attr_zone_status IASZone/ZoneStatus Attribute

MQTT Topic Pattern:

[PREFIX]/IASZone/Attributes/ZoneStatus/Reported
[PREFIX]/IASZone/Attributes/ZoneStatus/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IASZone Cluster ZoneStatus Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "IasZoneStatus"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ZoneStatus attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/IASZone/Attributes/ZoneStatus/+'

# Example output

ucl/by-unid/<UNID>/ep0/IASZone/Attributes/ZoneStatus/Desired { "value": <DESIRED_ZONE_STATUS>}
ucl/by-unid/<UNID>/ep0/IASZone/Attributes/ZoneStatus/Reported { "value": <REPORTED_ZONE_STATUS>}

\subsection ias_zone_attr_iascie_address IASZone/IASCIEAddress Attribute

MQTT Topic Pattern:

[PREFIX]/IASZone/Attributes/IASCIEAddress/Reported
[PREFIX]/IASZone/Attributes/IASCIEAddress/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IASZone Cluster IASCIEAddress Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "EUI64"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for IASCIEAddress attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/IASZone/Attributes/IASCIEAddress/+'

# Example output

ucl/by-unid/<UNID>/ep0/IASZone/Attributes/IASCIEAddress/Desired { "value": <DESIRED_IASCIE_ADDRESS>}
ucl/by-unid/<UNID>/ep0/IASZone/Attributes/IASCIEAddress/Reported { "value": <REPORTED_IASCIE_ADDRESS>}

\subsection ias_zone_attr_zoneid IASZone/ZoneID Attribute

MQTT Topic Pattern:

[PREFIX]/IASZone/Attributes/ZoneID/Reported
[PREFIX]/IASZone/Attributes/ZoneID/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IASZone Cluster ZoneID Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ZoneID attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/IASZone/Attributes/ZoneID/+'

# Example output

ucl/by-unid/<UNID>/ep0/IASZone/Attributes/ZoneID/Desired { "value": <DESIRED_ZONEID>}
ucl/by-unid/<UNID>/ep0/IASZone/Attributes/ZoneID/Reported { "value": <REPORTED_ZONEID>}

\subsection ias_zone_attr_number_of_zone_sensitivity_levels_supported IASZone/NumberOfZoneSensitivityLevelsSupported Attribute

MQTT Topic Pattern:

[PREFIX]/IASZone/Attributes/NumberOfZoneSensitivityLevelsSupported/Reported
[PREFIX]/IASZone/Attributes/NumberOfZoneSensitivityLevelsSupported/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IASZone Cluster NumberOfZoneSensitivityLevelsSupported Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for NumberOfZoneSensitivityLevelsSupported attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/IASZone/Attributes/NumberOfZoneSensitivityLevelsSupported/+'

# Example output

ucl/by-unid/<UNID>/ep0/IASZone/Attributes/NumberOfZoneSensitivityLevelsSupported/Desired { "value": <DESIRED_NUMBER_OF_ZONE_SENSITIVITY_LEVELS_SUPPORTED>}
ucl/by-unid/<UNID>/ep0/IASZone/Attributes/NumberOfZoneSensitivityLevelsSupported/Reported { "value": <REPORTED_NUMBER_OF_ZONE_SENSITIVITY_LEVELS_SUPPORTED>}

\subsection ias_zone_attr_current_zone_sensitivity_level IASZone/CurrentZoneSensitivityLevel Attribute

MQTT Topic Pattern:

[PREFIX]/IASZone/Attributes/CurrentZoneSensitivityLevel/Reported
[PREFIX]/IASZone/Attributes/CurrentZoneSensitivityLevel/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IASZone Cluster CurrentZoneSensitivityLevel Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CurrentZoneSensitivityLevel attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/IASZone/Attributes/CurrentZoneSensitivityLevel/+'

# Example output

ucl/by-unid/<UNID>/ep0/IASZone/Attributes/CurrentZoneSensitivityLevel/Desired { "value": <DESIRED_CURRENT_ZONE_SENSITIVITY_LEVEL>}
ucl/by-unid/<UNID>/ep0/IASZone/Attributes/CurrentZoneSensitivityLevel/Reported { "value": <REPORTED_CURRENT_ZONE_SENSITIVITY_LEVEL>}

\subsection ias_zone_attr_cluster_revision IASZone/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/IASZone/Attributes/ClusterRevision/Reported
[PREFIX]/IASZone/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IASZone Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/IASZone/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/IASZone/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/IASZone/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section ias_zone_recv_cmd_support IASZone Command Support

MQTT Topic Pattern:

[PREFIX]/IASZone/SupportedCommands
[PREFIX]/IASZone/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IASZone Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
              "ZoneEnrollResponse",
              "ZoneStatusChangeNotification",
              "InitiateNormalOperationMode",
              "ZoneEnrollRequest",
              "InitiateTestMode",
              "WriteAttributes",
              "ForceReadAttributes"
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for IASZone cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/IASZone/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/IASZone/SupportedCommands { "value": ["ZoneEnrollResponse","InitiateNormalOperationMode","InitiateTestMode","WriteAttributes", "ForceReadAttributes"] }

To see supported generated commands for IASZone cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/IASZone/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/IASZone/SupportedGeneratedCommands { "value": ["ZoneStatusChangeNotification","ZoneEnrollRequest",] }

\section ias_zone_cmds IASZone Commands

\subsection ias_zone_zone_enroll_response_cmd IASZone/ZoneEnrollResponse Command

MQTT Topic Pattern:

[PREFIX]/IASZone/Commands/ZoneEnrollResponse
[PREFIX]/IASZone/GeneratedCommands/ZoneEnrollResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IASZone Cluster ZoneEnrollResponse Command Properties",
  "type": "object",
  "properties": {
    "EnrollResponseCode": {
      "type": "ZoneEnrollResponseEnrollResponseCode"
    },
    "ZoneID": {
      "type": "integer"
    }
  },
  "required": [
    "EnrollResponseCode",
    "ZoneID"
  ]
}

Example Mosquitto CLI Tool Usage

To send a IASZone/ZoneEnrollResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/IASZone/Commands/ZoneEnrollResponse' -m  '{ "EnrollResponseCode": <ENROLL_RESPONSE_CODE_VALUE>,"ZoneID": <ZONEID_VALUE> }'

To receive a IASZone/ZoneEnrollResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/IASZone/GeneratedCommands/ZoneEnrollResponse'

\subsection ias_zone_zone_status_change_notification_cmd IASZone/ZoneStatusChangeNotification Command

MQTT Topic Pattern:

[PREFIX]/IASZone/Commands/ZoneStatusChangeNotification
[PREFIX]/IASZone/GeneratedCommands/ZoneStatusChangeNotification

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IASZone Cluster ZoneStatusChangeNotification Command Properties",
  "type": "object",
  "properties": {
    "ZoneStatus": {
      "type": "IasZoneStatus"
    },
    "ExtendedStatus": {
      "type": "ZoneStatusChangeNotificationExtendedStatus"
    },
    "ZoneID": {
      "type": "integer"
    },
    "Delay": {
      "type": "integer"
    }
  },
  "required": [
    "ZoneStatus",
    "ExtendedStatus",
    "ZoneID",
    "Delay"
  ]
}

Example Mosquitto CLI Tool Usage

To send a IASZone/ZoneStatusChangeNotification command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/IASZone/Commands/ZoneStatusChangeNotification' -m  '{ "ZoneStatus": <ZONE_STATUS_VALUE>,"ExtendedStatus": <EXTENDED_STATUS_VALUE>,"ZoneID": <ZONEID_VALUE>,"Delay": <DELAY_VALUE> }'

To receive a IASZone/ZoneStatusChangeNotification generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/IASZone/GeneratedCommands/ZoneStatusChangeNotification'

\subsection ias_zone_initiate_normal_operation_mode_cmd IASZone/InitiateNormalOperationMode Command

MQTT Topic Pattern:

[PREFIX]/IASZone/Commands/InitiateNormalOperationMode
[PREFIX]/IASZone/GeneratedCommands/InitiateNormalOperationMode

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IASZone Cluster InitiateNormalOperationMode Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
  ]
}

Example Mosquitto CLI Tool Usage

To send a IASZone/InitiateNormalOperationMode command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/IASZone/Commands/InitiateNormalOperationMode' -m  '{  }'

To receive a IASZone/InitiateNormalOperationMode generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/IASZone/GeneratedCommands/InitiateNormalOperationMode'

\subsection ias_zone_zone_enroll_request_cmd IASZone/ZoneEnrollRequest Command

MQTT Topic Pattern:

[PREFIX]/IASZone/Commands/ZoneEnrollRequest
[PREFIX]/IASZone/GeneratedCommands/ZoneEnrollRequest

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IASZone Cluster ZoneEnrollRequest Command Properties",
  "type": "object",
  "properties": {
    "ZoneType": {
      "type": "IasZoneType"
    },
    "ManufacturerCode": {
      "type": "integer"
    }
  },
  "required": [
    "ZoneType",
    "ManufacturerCode"
  ]
}

Example Mosquitto CLI Tool Usage

To send a IASZone/ZoneEnrollRequest command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/IASZone/Commands/ZoneEnrollRequest' -m  '{ "ZoneType": <ZONE_TYPE_VALUE>,"ManufacturerCode": <MANUFACTURER_CODE_VALUE> }'

To receive a IASZone/ZoneEnrollRequest generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/IASZone/GeneratedCommands/ZoneEnrollRequest'

\subsection ias_zone_initiate_test_mode_cmd IASZone/InitiateTestMode Command

MQTT Topic Pattern:

[PREFIX]/IASZone/Commands/InitiateTestMode
[PREFIX]/IASZone/GeneratedCommands/InitiateTestMode

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IASZone Cluster InitiateTestMode Command Properties",
  "type": "object",
  "properties": {
    "TestModeDuration": {
      "type": "integer"
    },
    "CurrentZoneSensitivityLevel": {
      "type": "integer"
    }
  },
  "required": [
    "TestModeDuration",
    "CurrentZoneSensitivityLevel"
  ]
}

Example Mosquitto CLI Tool Usage

To send a IASZone/InitiateTestMode command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/IASZone/Commands/InitiateTestMode' -m  '{ "TestModeDuration": <TEST_MODE_DURATION_VALUE>,"CurrentZoneSensitivityLevel": <CURRENT_ZONE_SENSITIVITY_LEVEL_VALUE> }'

To receive a IASZone/InitiateTestMode generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/IASZone/GeneratedCommands/InitiateTestMode'

\subsection ias_zone_write_attr_cmd IASZone/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/IASZone/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IASZone Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
    "IASCIEAddress": {
      "type": "EUI64"
    },
    "CurrentZoneSensitivityLevel": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all IASZone attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/IASZone/Commands/WriteAttributes' -m  '{ "IASCIEAddress": <IASCIE_ADDRESS_VALUE> ,"CurrentZoneSensitivityLevel": <CURRENT_ZONE_SENSITIVITY_LEVEL_VALUE>  }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection ias_zone_force_read_attr_cmd IASZone/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/IASZone/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IASZone Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "ZoneState",
          "ZoneType",
          "ZoneStatus",
          "IASCIEAddress",
          "ZoneID",
          "NumberOfZoneSensitivityLevelsSupported",
          "CurrentZoneSensitivityLevel"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all IASZone attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/IASZone/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the IASZone attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/IASZone/Commands/ForceReadAttributes' -m  '{ "value": ["ZoneState"] }'

\page iaswd IASWD Cluster The following commands and attributes are accepted as JSON payloads for the IASWD cluster.

\section iaswd_attrs IASWD Attributes The following attribute topics are used to retrieve the IASWD cluster state.

\subsection iaswd_attr_max_duration IASWD/MaxDuration Attribute

MQTT Topic Pattern:

[PREFIX]/IASWD/Attributes/MaxDuration/Reported
[PREFIX]/IASWD/Attributes/MaxDuration/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IASWD Cluster MaxDuration Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MaxDuration attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/IASWD/Attributes/MaxDuration/+'

# Example output

ucl/by-unid/<UNID>/ep0/IASWD/Attributes/MaxDuration/Desired { "value": <DESIRED_MAX_DURATION>}
ucl/by-unid/<UNID>/ep0/IASWD/Attributes/MaxDuration/Reported { "value": <REPORTED_MAX_DURATION>}

\subsection iaswd_attr_cluster_revision IASWD/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/IASWD/Attributes/ClusterRevision/Reported
[PREFIX]/IASWD/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IASWD Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/IASWD/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/IASWD/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/IASWD/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section iaswd_recv_cmd_support IASWD Command Support

MQTT Topic Pattern:

[PREFIX]/IASWD/SupportedCommands
[PREFIX]/IASWD/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IASWD Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
              "StartWarning",
              "Squawk",
              "WriteAttributes",
              "ForceReadAttributes"
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for IASWD cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/IASWD/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/IASWD/SupportedCommands { "value": ["StartWarning","Squawk","WriteAttributes", "ForceReadAttributes"] }

To see supported generated commands for IASWD cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/IASWD/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/IASWD/SupportedGeneratedCommands { "value": [] }

\section iaswd_cmds IASWD Commands

\subsection iaswd_start_warning_cmd IASWD/StartWarning Command

MQTT Topic Pattern:

[PREFIX]/IASWD/Commands/StartWarning
[PREFIX]/IASWD/GeneratedCommands/StartWarning

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IASWD Cluster StartWarning Command Properties",
  "type": "object",
  "properties": {
    "SirenConfiguration": {
      "type": "StartWarningSirenConfiguration"
    },
    "WarningDuration": {
      "type": "integer"
    },
    "StrobeDutyCycle": {
      "type": "integer"
    },
    "StrobeLevel": {
      "type": "IaswdLevel"
    }
  },
  "required": [
    "SirenConfiguration",
    "WarningDuration",
    "StrobeDutyCycle",
    "StrobeLevel"
  ]
}

Example Mosquitto CLI Tool Usage

To send a IASWD/StartWarning command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/IASWD/Commands/StartWarning' -m  '{ "SirenConfiguration": <SIREN_CONFIGURATION_VALUE>,"WarningDuration": <WARNING_DURATION_VALUE>,"StrobeDutyCycle": <STROBE_DUTY_CYCLE_VALUE>,"StrobeLevel": <STROBE_LEVEL_VALUE> }'

To receive a IASWD/StartWarning generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/IASWD/GeneratedCommands/StartWarning'

\subsection iaswd_squawk_cmd IASWD/Squawk Command

MQTT Topic Pattern:

[PREFIX]/IASWD/Commands/Squawk
[PREFIX]/IASWD/GeneratedCommands/Squawk

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IASWD Cluster Squawk Command Properties",
  "type": "object",
  "properties": {
    "SquawkConfiguration": {
      "type": "SquawkSquawkConfiguration"
    }
  },
  "required": [
    "SquawkConfiguration"
  ]
}

Example Mosquitto CLI Tool Usage

To send a IASWD/Squawk command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/IASWD/Commands/Squawk' -m  '{ "SquawkConfiguration": <SQUAWK_CONFIGURATION_VALUE> }'

To receive a IASWD/Squawk generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/IASWD/GeneratedCommands/Squawk'

\subsection iaswd_write_attr_cmd IASWD/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/IASWD/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IASWD Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
    "MaxDuration": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all IASWD attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/IASWD/Commands/WriteAttributes' -m  '{ "MaxDuration": <MAX_DURATION_VALUE>  }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection iaswd_force_read_attr_cmd IASWD/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/IASWD/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IASWD Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "MaxDuration"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all IASWD attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/IASWD/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the IASWD attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/IASWD/Commands/ForceReadAttributes' -m  '{ "value": ["MaxDuration"] }'

\page metering Metering Cluster The following commands and attributes are accepted as JSON payloads for the Metering cluster.

\section metering_attrs Metering Attributes The following attribute topics are used to retrieve the Metering cluster state.

\subsection metering_attr_current_summation_delivered Metering/CurrentSummationDelivered Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/CurrentSummationDelivered/Reported
[PREFIX]/Metering/Attributes/CurrentSummationDelivered/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Metering Cluster CurrentSummationDelivered Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CurrentSummationDelivered attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/CurrentSummationDelivered/+'

# Example output

ucl/by-unid/<UNID>/ep0/Metering/Attributes/CurrentSummationDelivered/Desired { "value": <DESIRED_CURRENT_SUMMATION_DELIVERED>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/CurrentSummationDelivered/Reported { "value": <REPORTED_CURRENT_SUMMATION_DELIVERED>}

\subsection metering_attr_current_summation_received Metering/CurrentSummationReceived Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/CurrentSummationReceived/Reported
[PREFIX]/Metering/Attributes/CurrentSummationReceived/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Metering Cluster CurrentSummationReceived Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CurrentSummationReceived attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/CurrentSummationReceived/+'

# Example output

ucl/by-unid/<UNID>/ep0/Metering/Attributes/CurrentSummationReceived/Desired { "value": <DESIRED_CURRENT_SUMMATION_RECEIVED>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/CurrentSummationReceived/Reported { "value": <REPORTED_CURRENT_SUMMATION_RECEIVED>}

\subsection metering_attr_current_max_demand_delivered Metering/CurrentMaxDemandDelivered Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/CurrentMaxDemandDelivered/Reported
[PREFIX]/Metering/Attributes/CurrentMaxDemandDelivered/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Metering Cluster CurrentMaxDemandDelivered Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CurrentMaxDemandDelivered attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/CurrentMaxDemandDelivered/+'

# Example output

ucl/by-unid/<UNID>/ep0/Metering/Attributes/CurrentMaxDemandDelivered/Desired { "value": <DESIRED_CURRENT_MAX_DEMAND_DELIVERED>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/CurrentMaxDemandDelivered/Reported { "value": <REPORTED_CURRENT_MAX_DEMAND_DELIVERED>}

\subsection metering_attr_current_max_demand_received Metering/CurrentMaxDemandReceived Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/CurrentMaxDemandReceived/Reported
[PREFIX]/Metering/Attributes/CurrentMaxDemandReceived/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Metering Cluster CurrentMaxDemandReceived Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CurrentMaxDemandReceived attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/CurrentMaxDemandReceived/+'

# Example output

ucl/by-unid/<UNID>/ep0/Metering/Attributes/CurrentMaxDemandReceived/Desired { "value": <DESIRED_CURRENT_MAX_DEMAND_RECEIVED>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/CurrentMaxDemandReceived/Reported { "value": <REPORTED_CURRENT_MAX_DEMAND_RECEIVED>}

\subsection metering_attr_power_factor Metering/PowerFactor Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/PowerFactor/Reported
[PREFIX]/Metering/Attributes/PowerFactor/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Metering Cluster PowerFactor Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for PowerFactor attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/PowerFactor/+'

# Example output

ucl/by-unid/<UNID>/ep0/Metering/Attributes/PowerFactor/Desired { "value": <DESIRED_POWER_FACTOR>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/PowerFactor/Reported { "value": <REPORTED_POWER_FACTOR>}

\subsection metering_attr_reading_snap_shot_time Metering/ReadingSnapShotTime Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/ReadingSnapShotTime/Reported
[PREFIX]/Metering/Attributes/ReadingSnapShotTime/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Metering Cluster ReadingSnapShotTime Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "UTC"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ReadingSnapShotTime attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/ReadingSnapShotTime/+'

# Example output

ucl/by-unid/<UNID>/ep0/Metering/Attributes/ReadingSnapShotTime/Desired { "value": <DESIRED_READING_SNAP_SHOT_TIME>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/ReadingSnapShotTime/Reported { "value": <REPORTED_READING_SNAP_SHOT_TIME>}

\subsection metering_attr_current_max_demand_delivered_time Metering/CurrentMaxDemandDeliveredTime Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/CurrentMaxDemandDeliveredTime/Reported
[PREFIX]/Metering/Attributes/CurrentMaxDemandDeliveredTime/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Metering Cluster CurrentMaxDemandDeliveredTime Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "UTC"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CurrentMaxDemandDeliveredTime attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/CurrentMaxDemandDeliveredTime/+'

# Example output

ucl/by-unid/<UNID>/ep0/Metering/Attributes/CurrentMaxDemandDeliveredTime/Desired { "value": <DESIRED_CURRENT_MAX_DEMAND_DELIVERED_TIME>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/CurrentMaxDemandDeliveredTime/Reported { "value": <REPORTED_CURRENT_MAX_DEMAND_DELIVERED_TIME>}

\subsection metering_attr_current_max_demand_received_time Metering/CurrentMaxDemandReceivedTime Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/CurrentMaxDemandReceivedTime/Reported
[PREFIX]/Metering/Attributes/CurrentMaxDemandReceivedTime/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Metering Cluster CurrentMaxDemandReceivedTime Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "UTC"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CurrentMaxDemandReceivedTime attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/CurrentMaxDemandReceivedTime/+'

# Example output

ucl/by-unid/<UNID>/ep0/Metering/Attributes/CurrentMaxDemandReceivedTime/Desired { "value": <DESIRED_CURRENT_MAX_DEMAND_RECEIVED_TIME>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/CurrentMaxDemandReceivedTime/Reported { "value": <REPORTED_CURRENT_MAX_DEMAND_RECEIVED_TIME>}

\subsection metering_attr_default_update_period Metering/DefaultUpdatePeriod Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/DefaultUpdatePeriod/Reported
[PREFIX]/Metering/Attributes/DefaultUpdatePeriod/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Metering Cluster DefaultUpdatePeriod Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DefaultUpdatePeriod attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/DefaultUpdatePeriod/+'

# Example output

ucl/by-unid/<UNID>/ep0/Metering/Attributes/DefaultUpdatePeriod/Desired { "value": <DESIRED_DEFAULT_UPDATE_PERIOD>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/DefaultUpdatePeriod/Reported { "value": <REPORTED_DEFAULT_UPDATE_PERIOD>}

\subsection metering_attr_supply_status Metering/SupplyStatus Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/SupplyStatus/Reported
[PREFIX]/Metering/Attributes/SupplyStatus/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Metering Cluster SupplyStatus Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "MeteringSupplyStatus"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for SupplyStatus attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/SupplyStatus/+'

# Example output

ucl/by-unid/<UNID>/ep0/Metering/Attributes/SupplyStatus/Desired { "value": <DESIRED_SUPPLY_STATUS>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/SupplyStatus/Reported { "value": <REPORTED_SUPPLY_STATUS>}

\subsection metering_attr_current_inlet_energy_carrier_summation Metering/CurrentInletEnergyCarrierSummation Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/CurrentInletEnergyCarrierSummation/Reported
[PREFIX]/Metering/Attributes/CurrentInletEnergyCarrierSummation/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Metering Cluster CurrentInletEnergyCarrierSummation Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CurrentInletEnergyCarrierSummation attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/CurrentInletEnergyCarrierSummation/+'

# Example output

ucl/by-unid/<UNID>/ep0/Metering/Attributes/CurrentInletEnergyCarrierSummation/Desired { "value": <DESIRED_CURRENT_INLET_ENERGY_CARRIER_SUMMATION>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/CurrentInletEnergyCarrierSummation/Reported { "value": <REPORTED_CURRENT_INLET_ENERGY_CARRIER_SUMMATION>}

\subsection metering_attr_current_outlet_energy_carrier_summation Metering/CurrentOutletEnergyCarrierSummation Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/CurrentOutletEnergyCarrierSummation/Reported
[PREFIX]/Metering/Attributes/CurrentOutletEnergyCarrierSummation/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Metering Cluster CurrentOutletEnergyCarrierSummation Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CurrentOutletEnergyCarrierSummation attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/CurrentOutletEnergyCarrierSummation/+'

# Example output

ucl/by-unid/<UNID>/ep0/Metering/Attributes/CurrentOutletEnergyCarrierSummation/Desired { "value": <DESIRED_CURRENT_OUTLET_ENERGY_CARRIER_SUMMATION>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/CurrentOutletEnergyCarrierSummation/Reported { "value": <REPORTED_CURRENT_OUTLET_ENERGY_CARRIER_SUMMATION>}

\subsection metering_attr_inlet_temperature Metering/InletTemperature Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/InletTemperature/Reported
[PREFIX]/Metering/Attributes/InletTemperature/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Metering Cluster InletTemperature Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "int24"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for InletTemperature attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/InletTemperature/+'

# Example output

ucl/by-unid/<UNID>/ep0/Metering/Attributes/InletTemperature/Desired { "value": <DESIRED_INLET_TEMPERATURE>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/InletTemperature/Reported { "value": <REPORTED_INLET_TEMPERATURE>}

\subsection metering_attr_outlet_temperature Metering/OutletTemperature Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/OutletTemperature/Reported
[PREFIX]/Metering/Attributes/OutletTemperature/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Metering Cluster OutletTemperature Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "int24"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for OutletTemperature attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/OutletTemperature/+'

# Example output

ucl/by-unid/<UNID>/ep0/Metering/Attributes/OutletTemperature/Desired { "value": <DESIRED_OUTLET_TEMPERATURE>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/OutletTemperature/Reported { "value": <REPORTED_OUTLET_TEMPERATURE>}

\subsection metering_attr_unitof_measure Metering/UnitofMeasure Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/UnitofMeasure/Reported
[PREFIX]/Metering/Attributes/UnitofMeasure/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Metering Cluster UnitofMeasure Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "MeteringUnitofMeasure"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for UnitofMeasure attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/UnitofMeasure/+'

# Example output

ucl/by-unid/<UNID>/ep0/Metering/Attributes/UnitofMeasure/Desired { "value": <DESIRED_UNITOF_MEASURE>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/UnitofMeasure/Reported { "value": <REPORTED_UNITOF_MEASURE>}

\subsection metering_attr_multiplier Metering/Multiplier Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/Multiplier/Reported
[PREFIX]/Metering/Attributes/Multiplier/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Metering Cluster Multiplier Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Multiplier attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/Multiplier/+'

# Example output

ucl/by-unid/<UNID>/ep0/Metering/Attributes/Multiplier/Desired { "value": <DESIRED_MULTIPLIER>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/Multiplier/Reported { "value": <REPORTED_MULTIPLIER>}

\subsection metering_attr_divisor Metering/Divisor Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/Divisor/Reported
[PREFIX]/Metering/Attributes/Divisor/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Metering Cluster Divisor Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Divisor attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/Divisor/+'

# Example output

ucl/by-unid/<UNID>/ep0/Metering/Attributes/Divisor/Desired { "value": <DESIRED_DIVISOR>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/Divisor/Reported { "value": <REPORTED_DIVISOR>}

\subsection metering_attr_summation_formatting Metering/SummationFormatting Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/SummationFormatting/Reported
[PREFIX]/Metering/Attributes/SummationFormatting/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Metering Cluster SummationFormatting Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "MeteringSummationFormatting"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for SummationFormatting attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/SummationFormatting/+'

# Example output

ucl/by-unid/<UNID>/ep0/Metering/Attributes/SummationFormatting/Desired { "value": <DESIRED_SUMMATION_FORMATTING>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/SummationFormatting/Reported { "value": <REPORTED_SUMMATION_FORMATTING>}

\subsection metering_attr_demand_formatting Metering/DemandFormatting Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/DemandFormatting/Reported
[PREFIX]/Metering/Attributes/DemandFormatting/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Metering Cluster DemandFormatting Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "MeteringDemandFormatting"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DemandFormatting attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/DemandFormatting/+'

# Example output

ucl/by-unid/<UNID>/ep0/Metering/Attributes/DemandFormatting/Desired { "value": <DESIRED_DEMAND_FORMATTING>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/DemandFormatting/Reported { "value": <REPORTED_DEMAND_FORMATTING>}

\subsection metering_attr_historical_consumption_formatting Metering/HistoricalConsumptionFormatting Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/HistoricalConsumptionFormatting/Reported
[PREFIX]/Metering/Attributes/HistoricalConsumptionFormatting/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Metering Cluster HistoricalConsumptionFormatting Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "MeteringHistoricalConsumptionFormatting"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for HistoricalConsumptionFormatting attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/HistoricalConsumptionFormatting/+'

# Example output

ucl/by-unid/<UNID>/ep0/Metering/Attributes/HistoricalConsumptionFormatting/Desired { "value": <DESIRED_HISTORICAL_CONSUMPTION_FORMATTING>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/HistoricalConsumptionFormatting/Reported { "value": <REPORTED_HISTORICAL_CONSUMPTION_FORMATTING>}

\subsection metering_attr_metering_device_type Metering/MeteringDeviceType Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/MeteringDeviceType/Reported
[PREFIX]/Metering/Attributes/MeteringDeviceType/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Metering Cluster MeteringDeviceType Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "MeteringMeteringDeviceType"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MeteringDeviceType attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/MeteringDeviceType/+'

# Example output

ucl/by-unid/<UNID>/ep0/Metering/Attributes/MeteringDeviceType/Desired { "value": <DESIRED_METERING_DEVICE_TYPE>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/MeteringDeviceType/Reported { "value": <REPORTED_METERING_DEVICE_TYPE>}

\subsection metering_attr_energy_carrier_unit_of_measure Metering/EnergyCarrierUnitOfMeasure Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/EnergyCarrierUnitOfMeasure/Reported
[PREFIX]/Metering/Attributes/EnergyCarrierUnitOfMeasure/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Metering Cluster EnergyCarrierUnitOfMeasure Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "MeteringEnergyCarrierUnitOfMeasure"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for EnergyCarrierUnitOfMeasure attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/EnergyCarrierUnitOfMeasure/+'

# Example output

ucl/by-unid/<UNID>/ep0/Metering/Attributes/EnergyCarrierUnitOfMeasure/Desired { "value": <DESIRED_ENERGY_CARRIER_UNIT_OF_MEASURE>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/EnergyCarrierUnitOfMeasure/Reported { "value": <REPORTED_ENERGY_CARRIER_UNIT_OF_MEASURE>}

\subsection metering_attr_energy_carrier_summation_formatting Metering/EnergyCarrierSummationFormatting Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/EnergyCarrierSummationFormatting/Reported
[PREFIX]/Metering/Attributes/EnergyCarrierSummationFormatting/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Metering Cluster EnergyCarrierSummationFormatting Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "MeteringEnergyCarrierSummationFormatting"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for EnergyCarrierSummationFormatting attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/EnergyCarrierSummationFormatting/+'

# Example output

ucl/by-unid/<UNID>/ep0/Metering/Attributes/EnergyCarrierSummationFormatting/Desired { "value": <DESIRED_ENERGY_CARRIER_SUMMATION_FORMATTING>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/EnergyCarrierSummationFormatting/Reported { "value": <REPORTED_ENERGY_CARRIER_SUMMATION_FORMATTING>}

\subsection metering_attr_energy_carrier_demand_formatting Metering/EnergyCarrierDemandFormatting Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/EnergyCarrierDemandFormatting/Reported
[PREFIX]/Metering/Attributes/EnergyCarrierDemandFormatting/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Metering Cluster EnergyCarrierDemandFormatting Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "MeteringEnergyCarrierDemandFormatting"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for EnergyCarrierDemandFormatting attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/EnergyCarrierDemandFormatting/+'

# Example output

ucl/by-unid/<UNID>/ep0/Metering/Attributes/EnergyCarrierDemandFormatting/Desired { "value": <DESIRED_ENERGY_CARRIER_DEMAND_FORMATTING>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/EnergyCarrierDemandFormatting/Reported { "value": <REPORTED_ENERGY_CARRIER_DEMAND_FORMATTING>}

\subsection metering_attr_temperature_unit_of_measure Metering/TemperatureUnitOfMeasure Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/TemperatureUnitOfMeasure/Reported
[PREFIX]/Metering/Attributes/TemperatureUnitOfMeasure/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Metering Cluster TemperatureUnitOfMeasure Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "MeteringTemperatureUnitOfMeasure"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for TemperatureUnitOfMeasure attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/TemperatureUnitOfMeasure/+'

# Example output

ucl/by-unid/<UNID>/ep0/Metering/Attributes/TemperatureUnitOfMeasure/Desired { "value": <DESIRED_TEMPERATURE_UNIT_OF_MEASURE>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/TemperatureUnitOfMeasure/Reported { "value": <REPORTED_TEMPERATURE_UNIT_OF_MEASURE>}

\subsection metering_attr_temperature_formatting Metering/TemperatureFormatting Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/TemperatureFormatting/Reported
[PREFIX]/Metering/Attributes/TemperatureFormatting/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Metering Cluster TemperatureFormatting Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "MeteringTemperatureFormatting"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for TemperatureFormatting attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/TemperatureFormatting/+'

# Example output

ucl/by-unid/<UNID>/ep0/Metering/Attributes/TemperatureFormatting/Desired { "value": <DESIRED_TEMPERATURE_FORMATTING>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/TemperatureFormatting/Reported { "value": <REPORTED_TEMPERATURE_FORMATTING>}

\subsection metering_attr_cluster_revision Metering/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/ClusterRevision/Reported
[PREFIX]/Metering/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Metering Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Metering/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/Metering/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/Metering/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section metering_recv_cmd_support Metering Command Support

MQTT Topic Pattern:

[PREFIX]/Metering/SupportedCommands
[PREFIX]/Metering/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Metering Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for Metering cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Metering/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/Metering/SupportedCommands { "value": [] }

To see supported generated commands for Metering cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Metering/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/Metering/SupportedGeneratedCommands { "value": [] }

\section metering_cmds Metering Commands

\subsection metering_write_attr_cmd Metering/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/Metering/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Metering Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all Metering attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Metering/Commands/WriteAttributes' -m  '{  }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection metering_force_read_attr_cmd Metering/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/Metering/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Metering Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "CurrentSummationDelivered",
          "CurrentSummationReceived",
          "CurrentMaxDemandDelivered",
          "CurrentMaxDemandReceived",
          "PowerFactor",
          "ReadingSnapShotTime",
          "CurrentMaxDemandDeliveredTime",
          "CurrentMaxDemandReceivedTime",
          "DefaultUpdatePeriod",
          "SupplyStatus",
          "CurrentInletEnergyCarrierSummation",
          "CurrentOutletEnergyCarrierSummation",
          "InletTemperature",
          "OutletTemperature",
          "UnitofMeasure",
          "Multiplier",
          "Divisor",
          "SummationFormatting",
          "DemandFormatting",
          "HistoricalConsumptionFormatting",
          "MeteringDeviceType",
          "EnergyCarrierUnitOfMeasure",
          "EnergyCarrierSummationFormatting",
          "EnergyCarrierDemandFormatting",
          "TemperatureUnitOfMeasure",
          "TemperatureFormatting"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all Metering attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Metering/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the Metering attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Metering/Commands/ForceReadAttributes' -m  '{ "value": ["CurrentSummationDelivered"] }'

\page electrical_measurement ElectricalMeasurement Cluster The following commands and attributes are accepted as JSON payloads for the ElectricalMeasurement cluster.

\section electrical_measurement_attrs ElectricalMeasurement Attributes The following attribute topics are used to retrieve the ElectricalMeasurement cluster state.

\subsection electrical_measurement_attr_measurement_type ElectricalMeasurement/MeasurementType Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/MeasurementType/Reported
[PREFIX]/ElectricalMeasurement/Attributes/MeasurementType/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster MeasurementType Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ElectricalMeasurementMeasurementType"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MeasurementType attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/MeasurementType/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/MeasurementType/Desired { "value": <DESIRED_MEASUREMENT_TYPE>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/MeasurementType/Reported { "value": <REPORTED_MEASUREMENT_TYPE>}

\subsection electrical_measurement_attr_dc_voltage ElectricalMeasurement/DCVoltage Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/DCVoltage/Reported
[PREFIX]/ElectricalMeasurement/Attributes/DCVoltage/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster DCVoltage Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DCVoltage attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/DCVoltage/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/DCVoltage/Desired { "value": <DESIRED_DC_VOLTAGE>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/DCVoltage/Reported { "value": <REPORTED_DC_VOLTAGE>}

\subsection electrical_measurement_attr_dc_voltage_min ElectricalMeasurement/DCVoltageMin Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/DCVoltageMin/Reported
[PREFIX]/ElectricalMeasurement/Attributes/DCVoltageMin/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster DCVoltageMin Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DCVoltageMin attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/DCVoltageMin/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/DCVoltageMin/Desired { "value": <DESIRED_DC_VOLTAGE_MIN>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/DCVoltageMin/Reported { "value": <REPORTED_DC_VOLTAGE_MIN>}

\subsection electrical_measurement_attr_dc_voltage_max ElectricalMeasurement/DCVoltageMax Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/DCVoltageMax/Reported
[PREFIX]/ElectricalMeasurement/Attributes/DCVoltageMax/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster DCVoltageMax Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DCVoltageMax attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/DCVoltageMax/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/DCVoltageMax/Desired { "value": <DESIRED_DC_VOLTAGE_MAX>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/DCVoltageMax/Reported { "value": <REPORTED_DC_VOLTAGE_MAX>}

\subsection electrical_measurement_attr_dc_current ElectricalMeasurement/DCCurrent Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/DCCurrent/Reported
[PREFIX]/ElectricalMeasurement/Attributes/DCCurrent/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster DCCurrent Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DCCurrent attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/DCCurrent/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/DCCurrent/Desired { "value": <DESIRED_DC_CURRENT>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/DCCurrent/Reported { "value": <REPORTED_DC_CURRENT>}

\subsection electrical_measurement_attr_dc_current_min ElectricalMeasurement/DCCurrentMin Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/DCCurrentMin/Reported
[PREFIX]/ElectricalMeasurement/Attributes/DCCurrentMin/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster DCCurrentMin Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DCCurrentMin attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/DCCurrentMin/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/DCCurrentMin/Desired { "value": <DESIRED_DC_CURRENT_MIN>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/DCCurrentMin/Reported { "value": <REPORTED_DC_CURRENT_MIN>}

\subsection electrical_measurement_attr_dc_current_max ElectricalMeasurement/DCCurrentMax Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/DCCurrentMax/Reported
[PREFIX]/ElectricalMeasurement/Attributes/DCCurrentMax/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster DCCurrentMax Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DCCurrentMax attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/DCCurrentMax/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/DCCurrentMax/Desired { "value": <DESIRED_DC_CURRENT_MAX>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/DCCurrentMax/Reported { "value": <REPORTED_DC_CURRENT_MAX>}

\subsection electrical_measurement_attr_dc_power ElectricalMeasurement/DCPower Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/DCPower/Reported
[PREFIX]/ElectricalMeasurement/Attributes/DCPower/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster DCPower Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DCPower attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/DCPower/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/DCPower/Desired { "value": <DESIRED_DC_POWER>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/DCPower/Reported { "value": <REPORTED_DC_POWER>}

\subsection electrical_measurement_attr_dc_power_min ElectricalMeasurement/DCPowerMin Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/DCPowerMin/Reported
[PREFIX]/ElectricalMeasurement/Attributes/DCPowerMin/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster DCPowerMin Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DCPowerMin attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/DCPowerMin/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/DCPowerMin/Desired { "value": <DESIRED_DC_POWER_MIN>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/DCPowerMin/Reported { "value": <REPORTED_DC_POWER_MIN>}

\subsection electrical_measurement_attr_dc_power_max ElectricalMeasurement/DCPowerMax Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/DCPowerMax/Reported
[PREFIX]/ElectricalMeasurement/Attributes/DCPowerMax/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster DCPowerMax Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DCPowerMax attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/DCPowerMax/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/DCPowerMax/Desired { "value": <DESIRED_DC_POWER_MAX>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/DCPowerMax/Reported { "value": <REPORTED_DC_POWER_MAX>}

\subsection electrical_measurement_attr_dc_voltage_multiplier ElectricalMeasurement/DCVoltageMultiplier Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/DCVoltageMultiplier/Reported
[PREFIX]/ElectricalMeasurement/Attributes/DCVoltageMultiplier/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster DCVoltageMultiplier Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DCVoltageMultiplier attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/DCVoltageMultiplier/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/DCVoltageMultiplier/Desired { "value": <DESIRED_DC_VOLTAGE_MULTIPLIER>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/DCVoltageMultiplier/Reported { "value": <REPORTED_DC_VOLTAGE_MULTIPLIER>}

\subsection electrical_measurement_attr_dc_voltage_divisor ElectricalMeasurement/DCVoltageDivisor Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/DCVoltageDivisor/Reported
[PREFIX]/ElectricalMeasurement/Attributes/DCVoltageDivisor/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster DCVoltageDivisor Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DCVoltageDivisor attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/DCVoltageDivisor/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/DCVoltageDivisor/Desired { "value": <DESIRED_DC_VOLTAGE_DIVISOR>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/DCVoltageDivisor/Reported { "value": <REPORTED_DC_VOLTAGE_DIVISOR>}

\subsection electrical_measurement_attr_dc_current_multiplier ElectricalMeasurement/DCCurrentMultiplier Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/DCCurrentMultiplier/Reported
[PREFIX]/ElectricalMeasurement/Attributes/DCCurrentMultiplier/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster DCCurrentMultiplier Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DCCurrentMultiplier attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/DCCurrentMultiplier/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/DCCurrentMultiplier/Desired { "value": <DESIRED_DC_CURRENT_MULTIPLIER>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/DCCurrentMultiplier/Reported { "value": <REPORTED_DC_CURRENT_MULTIPLIER>}

\subsection electrical_measurement_attr_dc_current_divisor ElectricalMeasurement/DCCurrentDivisor Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/DCCurrentDivisor/Reported
[PREFIX]/ElectricalMeasurement/Attributes/DCCurrentDivisor/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster DCCurrentDivisor Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DCCurrentDivisor attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/DCCurrentDivisor/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/DCCurrentDivisor/Desired { "value": <DESIRED_DC_CURRENT_DIVISOR>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/DCCurrentDivisor/Reported { "value": <REPORTED_DC_CURRENT_DIVISOR>}

\subsection electrical_measurement_attr_dc_power_multiplier ElectricalMeasurement/DCPowerMultiplier Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/DCPowerMultiplier/Reported
[PREFIX]/ElectricalMeasurement/Attributes/DCPowerMultiplier/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster DCPowerMultiplier Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DCPowerMultiplier attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/DCPowerMultiplier/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/DCPowerMultiplier/Desired { "value": <DESIRED_DC_POWER_MULTIPLIER>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/DCPowerMultiplier/Reported { "value": <REPORTED_DC_POWER_MULTIPLIER>}

\subsection electrical_measurement_attr_dc_power_divisor ElectricalMeasurement/DCPowerDivisor Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/DCPowerDivisor/Reported
[PREFIX]/ElectricalMeasurement/Attributes/DCPowerDivisor/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster DCPowerDivisor Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DCPowerDivisor attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/DCPowerDivisor/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/DCPowerDivisor/Desired { "value": <DESIRED_DC_POWER_DIVISOR>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/DCPowerDivisor/Reported { "value": <REPORTED_DC_POWER_DIVISOR>}

\subsection electrical_measurement_attr_ac_frequency ElectricalMeasurement/ACFrequency Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/ACFrequency/Reported
[PREFIX]/ElectricalMeasurement/Attributes/ACFrequency/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster ACFrequency Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ACFrequency attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/ACFrequency/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ACFrequency/Desired { "value": <DESIRED_AC_FREQUENCY>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ACFrequency/Reported { "value": <REPORTED_AC_FREQUENCY>}

\subsection electrical_measurement_attr_ac_frequency_min ElectricalMeasurement/ACFrequencyMin Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/ACFrequencyMin/Reported
[PREFIX]/ElectricalMeasurement/Attributes/ACFrequencyMin/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster ACFrequencyMin Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ACFrequencyMin attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/ACFrequencyMin/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ACFrequencyMin/Desired { "value": <DESIRED_AC_FREQUENCY_MIN>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ACFrequencyMin/Reported { "value": <REPORTED_AC_FREQUENCY_MIN>}

\subsection electrical_measurement_attr_ac_frequency_max ElectricalMeasurement/ACFrequencyMax Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/ACFrequencyMax/Reported
[PREFIX]/ElectricalMeasurement/Attributes/ACFrequencyMax/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster ACFrequencyMax Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ACFrequencyMax attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/ACFrequencyMax/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ACFrequencyMax/Desired { "value": <DESIRED_AC_FREQUENCY_MAX>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ACFrequencyMax/Reported { "value": <REPORTED_AC_FREQUENCY_MAX>}

\subsection electrical_measurement_attr_neutral_current ElectricalMeasurement/NeutralCurrent Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/NeutralCurrent/Reported
[PREFIX]/ElectricalMeasurement/Attributes/NeutralCurrent/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster NeutralCurrent Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for NeutralCurrent attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/NeutralCurrent/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/NeutralCurrent/Desired { "value": <DESIRED_NEUTRAL_CURRENT>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/NeutralCurrent/Reported { "value": <REPORTED_NEUTRAL_CURRENT>}

\subsection electrical_measurement_attr_total_active_power ElectricalMeasurement/TotalActivePower Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/TotalActivePower/Reported
[PREFIX]/ElectricalMeasurement/Attributes/TotalActivePower/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster TotalActivePower Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for TotalActivePower attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/TotalActivePower/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/TotalActivePower/Desired { "value": <DESIRED_TOTAL_ACTIVE_POWER>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/TotalActivePower/Reported { "value": <REPORTED_TOTAL_ACTIVE_POWER>}

\subsection electrical_measurement_attr_total_reactive_power ElectricalMeasurement/TotalReactivePower Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/TotalReactivePower/Reported
[PREFIX]/ElectricalMeasurement/Attributes/TotalReactivePower/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster TotalReactivePower Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for TotalReactivePower attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/TotalReactivePower/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/TotalReactivePower/Desired { "value": <DESIRED_TOTAL_REACTIVE_POWER>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/TotalReactivePower/Reported { "value": <REPORTED_TOTAL_REACTIVE_POWER>}

\subsection electrical_measurement_attr_total_apparent_power ElectricalMeasurement/TotalApparentPower Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/TotalApparentPower/Reported
[PREFIX]/ElectricalMeasurement/Attributes/TotalApparentPower/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster TotalApparentPower Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for TotalApparentPower attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/TotalApparentPower/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/TotalApparentPower/Desired { "value": <DESIRED_TOTAL_APPARENT_POWER>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/TotalApparentPower/Reported { "value": <REPORTED_TOTAL_APPARENT_POWER>}

\subsection electrical_measurement_attr_measured1st_harmonic_current ElectricalMeasurement/Measured1stHarmonicCurrent Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/Measured1stHarmonicCurrent/Reported
[PREFIX]/ElectricalMeasurement/Attributes/Measured1stHarmonicCurrent/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster Measured1stHarmonicCurrent Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Measured1stHarmonicCurrent attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/Measured1stHarmonicCurrent/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/Measured1stHarmonicCurrent/Desired { "value": <DESIRED_MEASURED1ST_HARMONIC_CURRENT>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/Measured1stHarmonicCurrent/Reported { "value": <REPORTED_MEASURED1ST_HARMONIC_CURRENT>}

\subsection electrical_measurement_attr_measured3rd_harmonic_current ElectricalMeasurement/Measured3rdHarmonicCurrent Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/Measured3rdHarmonicCurrent/Reported
[PREFIX]/ElectricalMeasurement/Attributes/Measured3rdHarmonicCurrent/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster Measured3rdHarmonicCurrent Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Measured3rdHarmonicCurrent attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/Measured3rdHarmonicCurrent/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/Measured3rdHarmonicCurrent/Desired { "value": <DESIRED_MEASURED3RD_HARMONIC_CURRENT>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/Measured3rdHarmonicCurrent/Reported { "value": <REPORTED_MEASURED3RD_HARMONIC_CURRENT>}

\subsection electrical_measurement_attr_measured5th_harmonic_current ElectricalMeasurement/Measured5thHarmonicCurrent Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/Measured5thHarmonicCurrent/Reported
[PREFIX]/ElectricalMeasurement/Attributes/Measured5thHarmonicCurrent/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster Measured5thHarmonicCurrent Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Measured5thHarmonicCurrent attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/Measured5thHarmonicCurrent/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/Measured5thHarmonicCurrent/Desired { "value": <DESIRED_MEASURED5TH_HARMONIC_CURRENT>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/Measured5thHarmonicCurrent/Reported { "value": <REPORTED_MEASURED5TH_HARMONIC_CURRENT>}

\subsection electrical_measurement_attr_measured7th_harmonic_current ElectricalMeasurement/Measured7thHarmonicCurrent Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/Measured7thHarmonicCurrent/Reported
[PREFIX]/ElectricalMeasurement/Attributes/Measured7thHarmonicCurrent/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster Measured7thHarmonicCurrent Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Measured7thHarmonicCurrent attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/Measured7thHarmonicCurrent/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/Measured7thHarmonicCurrent/Desired { "value": <DESIRED_MEASURED7TH_HARMONIC_CURRENT>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/Measured7thHarmonicCurrent/Reported { "value": <REPORTED_MEASURED7TH_HARMONIC_CURRENT>}

\subsection electrical_measurement_attr_measured9th_harmonic_current ElectricalMeasurement/Measured9thHarmonicCurrent Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/Measured9thHarmonicCurrent/Reported
[PREFIX]/ElectricalMeasurement/Attributes/Measured9thHarmonicCurrent/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster Measured9thHarmonicCurrent Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Measured9thHarmonicCurrent attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/Measured9thHarmonicCurrent/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/Measured9thHarmonicCurrent/Desired { "value": <DESIRED_MEASURED9TH_HARMONIC_CURRENT>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/Measured9thHarmonicCurrent/Reported { "value": <REPORTED_MEASURED9TH_HARMONIC_CURRENT>}

\subsection electrical_measurement_attr_measured11th_harmonic_current ElectricalMeasurement/Measured11thHarmonicCurrent Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/Measured11thHarmonicCurrent/Reported
[PREFIX]/ElectricalMeasurement/Attributes/Measured11thHarmonicCurrent/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster Measured11thHarmonicCurrent Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Measured11thHarmonicCurrent attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/Measured11thHarmonicCurrent/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/Measured11thHarmonicCurrent/Desired { "value": <DESIRED_MEASURED11TH_HARMONIC_CURRENT>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/Measured11thHarmonicCurrent/Reported { "value": <REPORTED_MEASURED11TH_HARMONIC_CURRENT>}

\subsection electrical_measurement_attr_measured_phase1st_harmonic_current ElectricalMeasurement/MeasuredPhase1stHarmonicCurrent Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/MeasuredPhase1stHarmonicCurrent/Reported
[PREFIX]/ElectricalMeasurement/Attributes/MeasuredPhase1stHarmonicCurrent/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster MeasuredPhase1stHarmonicCurrent Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MeasuredPhase1stHarmonicCurrent attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/MeasuredPhase1stHarmonicCurrent/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/MeasuredPhase1stHarmonicCurrent/Desired { "value": <DESIRED_MEASURED_PHASE1ST_HARMONIC_CURRENT>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/MeasuredPhase1stHarmonicCurrent/Reported { "value": <REPORTED_MEASURED_PHASE1ST_HARMONIC_CURRENT>}

\subsection electrical_measurement_attr_measured_phase3rd_harmonic_current ElectricalMeasurement/MeasuredPhase3rdHarmonicCurrent Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/MeasuredPhase3rdHarmonicCurrent/Reported
[PREFIX]/ElectricalMeasurement/Attributes/MeasuredPhase3rdHarmonicCurrent/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster MeasuredPhase3rdHarmonicCurrent Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MeasuredPhase3rdHarmonicCurrent attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/MeasuredPhase3rdHarmonicCurrent/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/MeasuredPhase3rdHarmonicCurrent/Desired { "value": <DESIRED_MEASURED_PHASE3RD_HARMONIC_CURRENT>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/MeasuredPhase3rdHarmonicCurrent/Reported { "value": <REPORTED_MEASURED_PHASE3RD_HARMONIC_CURRENT>}

\subsection electrical_measurement_attr_measured_phase5th_harmonic_current ElectricalMeasurement/MeasuredPhase5thHarmonicCurrent Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/MeasuredPhase5thHarmonicCurrent/Reported
[PREFIX]/ElectricalMeasurement/Attributes/MeasuredPhase5thHarmonicCurrent/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster MeasuredPhase5thHarmonicCurrent Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MeasuredPhase5thHarmonicCurrent attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/MeasuredPhase5thHarmonicCurrent/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/MeasuredPhase5thHarmonicCurrent/Desired { "value": <DESIRED_MEASURED_PHASE5TH_HARMONIC_CURRENT>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/MeasuredPhase5thHarmonicCurrent/Reported { "value": <REPORTED_MEASURED_PHASE5TH_HARMONIC_CURRENT>}

\subsection electrical_measurement_attr_measured_phase7th_harmonic_current ElectricalMeasurement/MeasuredPhase7thHarmonicCurrent Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/MeasuredPhase7thHarmonicCurrent/Reported
[PREFIX]/ElectricalMeasurement/Attributes/MeasuredPhase7thHarmonicCurrent/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster MeasuredPhase7thHarmonicCurrent Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MeasuredPhase7thHarmonicCurrent attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/MeasuredPhase7thHarmonicCurrent/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/MeasuredPhase7thHarmonicCurrent/Desired { "value": <DESIRED_MEASURED_PHASE7TH_HARMONIC_CURRENT>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/MeasuredPhase7thHarmonicCurrent/Reported { "value": <REPORTED_MEASURED_PHASE7TH_HARMONIC_CURRENT>}

\subsection electrical_measurement_attr_measured_phase9th_harmonic_current ElectricalMeasurement/MeasuredPhase9thHarmonicCurrent Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/MeasuredPhase9thHarmonicCurrent/Reported
[PREFIX]/ElectricalMeasurement/Attributes/MeasuredPhase9thHarmonicCurrent/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster MeasuredPhase9thHarmonicCurrent Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MeasuredPhase9thHarmonicCurrent attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/MeasuredPhase9thHarmonicCurrent/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/MeasuredPhase9thHarmonicCurrent/Desired { "value": <DESIRED_MEASURED_PHASE9TH_HARMONIC_CURRENT>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/MeasuredPhase9thHarmonicCurrent/Reported { "value": <REPORTED_MEASURED_PHASE9TH_HARMONIC_CURRENT>}

\subsection electrical_measurement_attr_measured_phase11th_harmonic_current ElectricalMeasurement/MeasuredPhase11thHarmonicCurrent Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/MeasuredPhase11thHarmonicCurrent/Reported
[PREFIX]/ElectricalMeasurement/Attributes/MeasuredPhase11thHarmonicCurrent/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster MeasuredPhase11thHarmonicCurrent Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MeasuredPhase11thHarmonicCurrent attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/MeasuredPhase11thHarmonicCurrent/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/MeasuredPhase11thHarmonicCurrent/Desired { "value": <DESIRED_MEASURED_PHASE11TH_HARMONIC_CURRENT>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/MeasuredPhase11thHarmonicCurrent/Reported { "value": <REPORTED_MEASURED_PHASE11TH_HARMONIC_CURRENT>}

\subsection electrical_measurement_attr_ac_frequency_multiplier ElectricalMeasurement/ACFrequencyMultiplier Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/ACFrequencyMultiplier/Reported
[PREFIX]/ElectricalMeasurement/Attributes/ACFrequencyMultiplier/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster ACFrequencyMultiplier Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ACFrequencyMultiplier attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/ACFrequencyMultiplier/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ACFrequencyMultiplier/Desired { "value": <DESIRED_AC_FREQUENCY_MULTIPLIER>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ACFrequencyMultiplier/Reported { "value": <REPORTED_AC_FREQUENCY_MULTIPLIER>}

\subsection electrical_measurement_attr_ac_frequency_divisor ElectricalMeasurement/ACFrequencyDivisor Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/ACFrequencyDivisor/Reported
[PREFIX]/ElectricalMeasurement/Attributes/ACFrequencyDivisor/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster ACFrequencyDivisor Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ACFrequencyDivisor attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/ACFrequencyDivisor/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ACFrequencyDivisor/Desired { "value": <DESIRED_AC_FREQUENCY_DIVISOR>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ACFrequencyDivisor/Reported { "value": <REPORTED_AC_FREQUENCY_DIVISOR>}

\subsection electrical_measurement_attr_power_multiplier ElectricalMeasurement/PowerMultiplier Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/PowerMultiplier/Reported
[PREFIX]/ElectricalMeasurement/Attributes/PowerMultiplier/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster PowerMultiplier Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for PowerMultiplier attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/PowerMultiplier/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/PowerMultiplier/Desired { "value": <DESIRED_POWER_MULTIPLIER>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/PowerMultiplier/Reported { "value": <REPORTED_POWER_MULTIPLIER>}

\subsection electrical_measurement_attr_power_divisor ElectricalMeasurement/PowerDivisor Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/PowerDivisor/Reported
[PREFIX]/ElectricalMeasurement/Attributes/PowerDivisor/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster PowerDivisor Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for PowerDivisor attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/PowerDivisor/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/PowerDivisor/Desired { "value": <DESIRED_POWER_DIVISOR>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/PowerDivisor/Reported { "value": <REPORTED_POWER_DIVISOR>}

\subsection electrical_measurement_attr_harmonic_current_multiplier ElectricalMeasurement/HarmonicCurrentMultiplier Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/HarmonicCurrentMultiplier/Reported
[PREFIX]/ElectricalMeasurement/Attributes/HarmonicCurrentMultiplier/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster HarmonicCurrentMultiplier Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for HarmonicCurrentMultiplier attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/HarmonicCurrentMultiplier/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/HarmonicCurrentMultiplier/Desired { "value": <DESIRED_HARMONIC_CURRENT_MULTIPLIER>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/HarmonicCurrentMultiplier/Reported { "value": <REPORTED_HARMONIC_CURRENT_MULTIPLIER>}

\subsection electrical_measurement_attr_phase_harmonic_current_multiplier ElectricalMeasurement/PhaseHarmonicCurrentMultiplier Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/PhaseHarmonicCurrentMultiplier/Reported
[PREFIX]/ElectricalMeasurement/Attributes/PhaseHarmonicCurrentMultiplier/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster PhaseHarmonicCurrentMultiplier Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for PhaseHarmonicCurrentMultiplier attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/PhaseHarmonicCurrentMultiplier/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/PhaseHarmonicCurrentMultiplier/Desired { "value": <DESIRED_PHASE_HARMONIC_CURRENT_MULTIPLIER>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/PhaseHarmonicCurrentMultiplier/Reported { "value": <REPORTED_PHASE_HARMONIC_CURRENT_MULTIPLIER>}

\subsection electrical_measurement_attr_line_current ElectricalMeasurement/LineCurrent Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/LineCurrent/Reported
[PREFIX]/ElectricalMeasurement/Attributes/LineCurrent/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster LineCurrent Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for LineCurrent attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/LineCurrent/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/LineCurrent/Desired { "value": <DESIRED_LINE_CURRENT>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/LineCurrent/Reported { "value": <REPORTED_LINE_CURRENT>}

\subsection electrical_measurement_attr_active_current ElectricalMeasurement/ActiveCurrent Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/ActiveCurrent/Reported
[PREFIX]/ElectricalMeasurement/Attributes/ActiveCurrent/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster ActiveCurrent Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ActiveCurrent attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/ActiveCurrent/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ActiveCurrent/Desired { "value": <DESIRED_ACTIVE_CURRENT>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ActiveCurrent/Reported { "value": <REPORTED_ACTIVE_CURRENT>}

\subsection electrical_measurement_attr_reactive_current ElectricalMeasurement/ReactiveCurrent Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/ReactiveCurrent/Reported
[PREFIX]/ElectricalMeasurement/Attributes/ReactiveCurrent/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster ReactiveCurrent Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ReactiveCurrent attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/ReactiveCurrent/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ReactiveCurrent/Desired { "value": <DESIRED_REACTIVE_CURRENT>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ReactiveCurrent/Reported { "value": <REPORTED_REACTIVE_CURRENT>}

\subsection electrical_measurement_attr_rms_voltage ElectricalMeasurement/RMSVoltage Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/RMSVoltage/Reported
[PREFIX]/ElectricalMeasurement/Attributes/RMSVoltage/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster RMSVoltage Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RMSVoltage attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/RMSVoltage/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSVoltage/Desired { "value": <DESIRED_RMS_VOLTAGE>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSVoltage/Reported { "value": <REPORTED_RMS_VOLTAGE>}

\subsection electrical_measurement_attr_rms_voltage_min ElectricalMeasurement/RMSVoltageMin Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/RMSVoltageMin/Reported
[PREFIX]/ElectricalMeasurement/Attributes/RMSVoltageMin/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster RMSVoltageMin Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RMSVoltageMin attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/RMSVoltageMin/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSVoltageMin/Desired { "value": <DESIRED_RMS_VOLTAGE_MIN>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSVoltageMin/Reported { "value": <REPORTED_RMS_VOLTAGE_MIN>}

\subsection electrical_measurement_attr_rms_voltage_max ElectricalMeasurement/RMSVoltageMax Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/RMSVoltageMax/Reported
[PREFIX]/ElectricalMeasurement/Attributes/RMSVoltageMax/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster RMSVoltageMax Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RMSVoltageMax attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/RMSVoltageMax/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSVoltageMax/Desired { "value": <DESIRED_RMS_VOLTAGE_MAX>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSVoltageMax/Reported { "value": <REPORTED_RMS_VOLTAGE_MAX>}

\subsection electrical_measurement_attr_rms_current ElectricalMeasurement/RMSCurrent Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/RMSCurrent/Reported
[PREFIX]/ElectricalMeasurement/Attributes/RMSCurrent/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster RMSCurrent Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RMSCurrent attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/RMSCurrent/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSCurrent/Desired { "value": <DESIRED_RMS_CURRENT>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSCurrent/Reported { "value": <REPORTED_RMS_CURRENT>}

\subsection electrical_measurement_attr_rms_current_min ElectricalMeasurement/RMSCurrentMin Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/RMSCurrentMin/Reported
[PREFIX]/ElectricalMeasurement/Attributes/RMSCurrentMin/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster RMSCurrentMin Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RMSCurrentMin attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/RMSCurrentMin/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSCurrentMin/Desired { "value": <DESIRED_RMS_CURRENT_MIN>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSCurrentMin/Reported { "value": <REPORTED_RMS_CURRENT_MIN>}

\subsection electrical_measurement_attr_rms_current_max ElectricalMeasurement/RMSCurrentMax Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/RMSCurrentMax/Reported
[PREFIX]/ElectricalMeasurement/Attributes/RMSCurrentMax/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster RMSCurrentMax Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RMSCurrentMax attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/RMSCurrentMax/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSCurrentMax/Desired { "value": <DESIRED_RMS_CURRENT_MAX>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSCurrentMax/Reported { "value": <REPORTED_RMS_CURRENT_MAX>}

\subsection electrical_measurement_attr_active_power ElectricalMeasurement/ActivePower Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/ActivePower/Reported
[PREFIX]/ElectricalMeasurement/Attributes/ActivePower/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster ActivePower Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ActivePower attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/ActivePower/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ActivePower/Desired { "value": <DESIRED_ACTIVE_POWER>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ActivePower/Reported { "value": <REPORTED_ACTIVE_POWER>}

\subsection electrical_measurement_attr_active_power_min ElectricalMeasurement/ActivePowerMin Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/ActivePowerMin/Reported
[PREFIX]/ElectricalMeasurement/Attributes/ActivePowerMin/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster ActivePowerMin Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ActivePowerMin attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/ActivePowerMin/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ActivePowerMin/Desired { "value": <DESIRED_ACTIVE_POWER_MIN>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ActivePowerMin/Reported { "value": <REPORTED_ACTIVE_POWER_MIN>}

\subsection electrical_measurement_attr_active_power_max ElectricalMeasurement/ActivePowerMax Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/ActivePowerMax/Reported
[PREFIX]/ElectricalMeasurement/Attributes/ActivePowerMax/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster ActivePowerMax Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ActivePowerMax attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/ActivePowerMax/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ActivePowerMax/Desired { "value": <DESIRED_ACTIVE_POWER_MAX>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ActivePowerMax/Reported { "value": <REPORTED_ACTIVE_POWER_MAX>}

\subsection electrical_measurement_attr_reactive_power ElectricalMeasurement/ReactivePower Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/ReactivePower/Reported
[PREFIX]/ElectricalMeasurement/Attributes/ReactivePower/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster ReactivePower Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ReactivePower attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/ReactivePower/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ReactivePower/Desired { "value": <DESIRED_REACTIVE_POWER>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ReactivePower/Reported { "value": <REPORTED_REACTIVE_POWER>}

\subsection electrical_measurement_attr_apparent_power ElectricalMeasurement/ApparentPower Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/ApparentPower/Reported
[PREFIX]/ElectricalMeasurement/Attributes/ApparentPower/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster ApparentPower Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ApparentPower attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/ApparentPower/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ApparentPower/Desired { "value": <DESIRED_APPARENT_POWER>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ApparentPower/Reported { "value": <REPORTED_APPARENT_POWER>}

\subsection electrical_measurement_attr_power_factor ElectricalMeasurement/PowerFactor Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/PowerFactor/Reported
[PREFIX]/ElectricalMeasurement/Attributes/PowerFactor/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster PowerFactor Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for PowerFactor attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/PowerFactor/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/PowerFactor/Desired { "value": <DESIRED_POWER_FACTOR>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/PowerFactor/Reported { "value": <REPORTED_POWER_FACTOR>}

\subsection electrical_measurement_attr_average_rms_voltage_measurement_period ElectricalMeasurement/AverageRMSVoltageMeasurementPeriod Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/AverageRMSVoltageMeasurementPeriod/Reported
[PREFIX]/ElectricalMeasurement/Attributes/AverageRMSVoltageMeasurementPeriod/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster AverageRMSVoltageMeasurementPeriod Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for AverageRMSVoltageMeasurementPeriod attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/AverageRMSVoltageMeasurementPeriod/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/AverageRMSVoltageMeasurementPeriod/Desired { "value": <DESIRED_AVERAGE_RMS_VOLTAGE_MEASUREMENT_PERIOD>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/AverageRMSVoltageMeasurementPeriod/Reported { "value": <REPORTED_AVERAGE_RMS_VOLTAGE_MEASUREMENT_PERIOD>}

\subsection electrical_measurement_attr_average_rms_over_voltage_counter ElectricalMeasurement/AverageRMSOverVoltageCounter Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/AverageRMSOverVoltageCounter/Reported
[PREFIX]/ElectricalMeasurement/Attributes/AverageRMSOverVoltageCounter/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster AverageRMSOverVoltageCounter Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for AverageRMSOverVoltageCounter attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/AverageRMSOverVoltageCounter/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/AverageRMSOverVoltageCounter/Desired { "value": <DESIRED_AVERAGE_RMS_OVER_VOLTAGE_COUNTER>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/AverageRMSOverVoltageCounter/Reported { "value": <REPORTED_AVERAGE_RMS_OVER_VOLTAGE_COUNTER>}

\subsection electrical_measurement_attr_average_rms_under_voltage_counter ElectricalMeasurement/AverageRMSUnderVoltageCounter Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/AverageRMSUnderVoltageCounter/Reported
[PREFIX]/ElectricalMeasurement/Attributes/AverageRMSUnderVoltageCounter/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster AverageRMSUnderVoltageCounter Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for AverageRMSUnderVoltageCounter attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/AverageRMSUnderVoltageCounter/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/AverageRMSUnderVoltageCounter/Desired { "value": <DESIRED_AVERAGE_RMS_UNDER_VOLTAGE_COUNTER>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/AverageRMSUnderVoltageCounter/Reported { "value": <REPORTED_AVERAGE_RMS_UNDER_VOLTAGE_COUNTER>}

\subsection electrical_measurement_attr_rms_extreme_over_voltage_period ElectricalMeasurement/RMSExtremeOverVoltagePeriod Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/RMSExtremeOverVoltagePeriod/Reported
[PREFIX]/ElectricalMeasurement/Attributes/RMSExtremeOverVoltagePeriod/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster RMSExtremeOverVoltagePeriod Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RMSExtremeOverVoltagePeriod attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/RMSExtremeOverVoltagePeriod/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSExtremeOverVoltagePeriod/Desired { "value": <DESIRED_RMS_EXTREME_OVER_VOLTAGE_PERIOD>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSExtremeOverVoltagePeriod/Reported { "value": <REPORTED_RMS_EXTREME_OVER_VOLTAGE_PERIOD>}

\subsection electrical_measurement_attr_rms_extreme_under_voltage_period ElectricalMeasurement/RMSExtremeUnderVoltagePeriod Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/RMSExtremeUnderVoltagePeriod/Reported
[PREFIX]/ElectricalMeasurement/Attributes/RMSExtremeUnderVoltagePeriod/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster RMSExtremeUnderVoltagePeriod Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RMSExtremeUnderVoltagePeriod attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/RMSExtremeUnderVoltagePeriod/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSExtremeUnderVoltagePeriod/Desired { "value": <DESIRED_RMS_EXTREME_UNDER_VOLTAGE_PERIOD>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSExtremeUnderVoltagePeriod/Reported { "value": <REPORTED_RMS_EXTREME_UNDER_VOLTAGE_PERIOD>}

\subsection electrical_measurement_attr_rms_voltage_sag_period ElectricalMeasurement/RMSVoltageSagPeriod Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/RMSVoltageSagPeriod/Reported
[PREFIX]/ElectricalMeasurement/Attributes/RMSVoltageSagPeriod/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster RMSVoltageSagPeriod Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RMSVoltageSagPeriod attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/RMSVoltageSagPeriod/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSVoltageSagPeriod/Desired { "value": <DESIRED_RMS_VOLTAGE_SAG_PERIOD>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSVoltageSagPeriod/Reported { "value": <REPORTED_RMS_VOLTAGE_SAG_PERIOD>}

\subsection electrical_measurement_attr_rms_voltage_swell_period ElectricalMeasurement/RMSVoltageSwellPeriod Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/RMSVoltageSwellPeriod/Reported
[PREFIX]/ElectricalMeasurement/Attributes/RMSVoltageSwellPeriod/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster RMSVoltageSwellPeriod Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RMSVoltageSwellPeriod attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/RMSVoltageSwellPeriod/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSVoltageSwellPeriod/Desired { "value": <DESIRED_RMS_VOLTAGE_SWELL_PERIOD>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSVoltageSwellPeriod/Reported { "value": <REPORTED_RMS_VOLTAGE_SWELL_PERIOD>}

\subsection electrical_measurement_attr_ac_voltage_multiplier ElectricalMeasurement/ACVoltageMultiplier Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/ACVoltageMultiplier/Reported
[PREFIX]/ElectricalMeasurement/Attributes/ACVoltageMultiplier/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster ACVoltageMultiplier Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ACVoltageMultiplier attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/ACVoltageMultiplier/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ACVoltageMultiplier/Desired { "value": <DESIRED_AC_VOLTAGE_MULTIPLIER>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ACVoltageMultiplier/Reported { "value": <REPORTED_AC_VOLTAGE_MULTIPLIER>}

\subsection electrical_measurement_attr_ac_voltage_divisor ElectricalMeasurement/ACVoltageDivisor Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/ACVoltageDivisor/Reported
[PREFIX]/ElectricalMeasurement/Attributes/ACVoltageDivisor/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster ACVoltageDivisor Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ACVoltageDivisor attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/ACVoltageDivisor/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ACVoltageDivisor/Desired { "value": <DESIRED_AC_VOLTAGE_DIVISOR>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ACVoltageDivisor/Reported { "value": <REPORTED_AC_VOLTAGE_DIVISOR>}

\subsection electrical_measurement_attr_ac_current_multiplier ElectricalMeasurement/ACCurrentMultiplier Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/ACCurrentMultiplier/Reported
[PREFIX]/ElectricalMeasurement/Attributes/ACCurrentMultiplier/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster ACCurrentMultiplier Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ACCurrentMultiplier attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/ACCurrentMultiplier/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ACCurrentMultiplier/Desired { "value": <DESIRED_AC_CURRENT_MULTIPLIER>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ACCurrentMultiplier/Reported { "value": <REPORTED_AC_CURRENT_MULTIPLIER>}

\subsection electrical_measurement_attr_ac_current_divisor ElectricalMeasurement/ACCurrentDivisor Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/ACCurrentDivisor/Reported
[PREFIX]/ElectricalMeasurement/Attributes/ACCurrentDivisor/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster ACCurrentDivisor Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ACCurrentDivisor attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/ACCurrentDivisor/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ACCurrentDivisor/Desired { "value": <DESIRED_AC_CURRENT_DIVISOR>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ACCurrentDivisor/Reported { "value": <REPORTED_AC_CURRENT_DIVISOR>}

\subsection electrical_measurement_attr_ac_power_multiplier ElectricalMeasurement/ACPowerMultiplier Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/ACPowerMultiplier/Reported
[PREFIX]/ElectricalMeasurement/Attributes/ACPowerMultiplier/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster ACPowerMultiplier Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ACPowerMultiplier attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/ACPowerMultiplier/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ACPowerMultiplier/Desired { "value": <DESIRED_AC_POWER_MULTIPLIER>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ACPowerMultiplier/Reported { "value": <REPORTED_AC_POWER_MULTIPLIER>}

\subsection electrical_measurement_attr_ac_power_divisor ElectricalMeasurement/ACPowerDivisor Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/ACPowerDivisor/Reported
[PREFIX]/ElectricalMeasurement/Attributes/ACPowerDivisor/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster ACPowerDivisor Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ACPowerDivisor attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/ACPowerDivisor/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ACPowerDivisor/Desired { "value": <DESIRED_AC_POWER_DIVISOR>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ACPowerDivisor/Reported { "value": <REPORTED_AC_POWER_DIVISOR>}

\subsection electrical_measurement_attr_dc_overload_alarms_mask ElectricalMeasurement/DCOverloadAlarmsMask Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/DCOverloadAlarmsMask/Reported
[PREFIX]/ElectricalMeasurement/Attributes/DCOverloadAlarmsMask/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster DCOverloadAlarmsMask Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ElectricalMeasurementDCOverloadAlarmsMask"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DCOverloadAlarmsMask attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/DCOverloadAlarmsMask/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/DCOverloadAlarmsMask/Desired { "value": <DESIRED_DC_OVERLOAD_ALARMS_MASK>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/DCOverloadAlarmsMask/Reported { "value": <REPORTED_DC_OVERLOAD_ALARMS_MASK>}

\subsection electrical_measurement_attr_dc_voltage_overload ElectricalMeasurement/DCVoltageOverload Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/DCVoltageOverload/Reported
[PREFIX]/ElectricalMeasurement/Attributes/DCVoltageOverload/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster DCVoltageOverload Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DCVoltageOverload attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/DCVoltageOverload/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/DCVoltageOverload/Desired { "value": <DESIRED_DC_VOLTAGE_OVERLOAD>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/DCVoltageOverload/Reported { "value": <REPORTED_DC_VOLTAGE_OVERLOAD>}

\subsection electrical_measurement_attr_dc_current_overload ElectricalMeasurement/DCCurrentOverload Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/DCCurrentOverload/Reported
[PREFIX]/ElectricalMeasurement/Attributes/DCCurrentOverload/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster DCCurrentOverload Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DCCurrentOverload attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/DCCurrentOverload/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/DCCurrentOverload/Desired { "value": <DESIRED_DC_CURRENT_OVERLOAD>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/DCCurrentOverload/Reported { "value": <REPORTED_DC_CURRENT_OVERLOAD>}

\subsection electrical_measurement_attr_ac_alarms_mask ElectricalMeasurement/ACAlarmsMask Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/ACAlarmsMask/Reported
[PREFIX]/ElectricalMeasurement/Attributes/ACAlarmsMask/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster ACAlarmsMask Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ElectricalMeasurementACAlarmsMask"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ACAlarmsMask attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/ACAlarmsMask/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ACAlarmsMask/Desired { "value": <DESIRED_AC_ALARMS_MASK>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ACAlarmsMask/Reported { "value": <REPORTED_AC_ALARMS_MASK>}

\subsection electrical_measurement_attr_ac_voltage_overload ElectricalMeasurement/ACVoltageOverload Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/ACVoltageOverload/Reported
[PREFIX]/ElectricalMeasurement/Attributes/ACVoltageOverload/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster ACVoltageOverload Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ACVoltageOverload attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/ACVoltageOverload/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ACVoltageOverload/Desired { "value": <DESIRED_AC_VOLTAGE_OVERLOAD>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ACVoltageOverload/Reported { "value": <REPORTED_AC_VOLTAGE_OVERLOAD>}

\subsection electrical_measurement_attr_ac_current_overload ElectricalMeasurement/ACCurrentOverload Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/ACCurrentOverload/Reported
[PREFIX]/ElectricalMeasurement/Attributes/ACCurrentOverload/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster ACCurrentOverload Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ACCurrentOverload attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/ACCurrentOverload/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ACCurrentOverload/Desired { "value": <DESIRED_AC_CURRENT_OVERLOAD>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ACCurrentOverload/Reported { "value": <REPORTED_AC_CURRENT_OVERLOAD>}

\subsection electrical_measurement_attr_ac_active_power_overload ElectricalMeasurement/ACActivePowerOverload Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/ACActivePowerOverload/Reported
[PREFIX]/ElectricalMeasurement/Attributes/ACActivePowerOverload/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster ACActivePowerOverload Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ACActivePowerOverload attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/ACActivePowerOverload/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ACActivePowerOverload/Desired { "value": <DESIRED_AC_ACTIVE_POWER_OVERLOAD>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ACActivePowerOverload/Reported { "value": <REPORTED_AC_ACTIVE_POWER_OVERLOAD>}

\subsection electrical_measurement_attr_ac_reactive_power_overload ElectricalMeasurement/ACReactivePowerOverload Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/ACReactivePowerOverload/Reported
[PREFIX]/ElectricalMeasurement/Attributes/ACReactivePowerOverload/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster ACReactivePowerOverload Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ACReactivePowerOverload attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/ACReactivePowerOverload/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ACReactivePowerOverload/Desired { "value": <DESIRED_AC_REACTIVE_POWER_OVERLOAD>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ACReactivePowerOverload/Reported { "value": <REPORTED_AC_REACTIVE_POWER_OVERLOAD>}

\subsection electrical_measurement_attr_average_rms_over_voltage ElectricalMeasurement/AverageRMSOverVoltage Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/AverageRMSOverVoltage/Reported
[PREFIX]/ElectricalMeasurement/Attributes/AverageRMSOverVoltage/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster AverageRMSOverVoltage Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for AverageRMSOverVoltage attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/AverageRMSOverVoltage/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/AverageRMSOverVoltage/Desired { "value": <DESIRED_AVERAGE_RMS_OVER_VOLTAGE>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/AverageRMSOverVoltage/Reported { "value": <REPORTED_AVERAGE_RMS_OVER_VOLTAGE>}

\subsection electrical_measurement_attr_average_rms_under_voltage ElectricalMeasurement/AverageRMSUnderVoltage Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/AverageRMSUnderVoltage/Reported
[PREFIX]/ElectricalMeasurement/Attributes/AverageRMSUnderVoltage/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster AverageRMSUnderVoltage Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for AverageRMSUnderVoltage attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/AverageRMSUnderVoltage/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/AverageRMSUnderVoltage/Desired { "value": <DESIRED_AVERAGE_RMS_UNDER_VOLTAGE>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/AverageRMSUnderVoltage/Reported { "value": <REPORTED_AVERAGE_RMS_UNDER_VOLTAGE>}

\subsection electrical_measurement_attr_rms_extreme_over_voltage ElectricalMeasurement/RMSExtremeOverVoltage Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/RMSExtremeOverVoltage/Reported
[PREFIX]/ElectricalMeasurement/Attributes/RMSExtremeOverVoltage/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster RMSExtremeOverVoltage Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RMSExtremeOverVoltage attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/RMSExtremeOverVoltage/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSExtremeOverVoltage/Desired { "value": <DESIRED_RMS_EXTREME_OVER_VOLTAGE>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSExtremeOverVoltage/Reported { "value": <REPORTED_RMS_EXTREME_OVER_VOLTAGE>}

\subsection electrical_measurement_attr_rms_extreme_under_voltage ElectricalMeasurement/RMSExtremeUnderVoltage Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/RMSExtremeUnderVoltage/Reported
[PREFIX]/ElectricalMeasurement/Attributes/RMSExtremeUnderVoltage/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster RMSExtremeUnderVoltage Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RMSExtremeUnderVoltage attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/RMSExtremeUnderVoltage/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSExtremeUnderVoltage/Desired { "value": <DESIRED_RMS_EXTREME_UNDER_VOLTAGE>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSExtremeUnderVoltage/Reported { "value": <REPORTED_RMS_EXTREME_UNDER_VOLTAGE>}

\subsection electrical_measurement_attr_rms_voltage_sag ElectricalMeasurement/RMSVoltageSag Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/RMSVoltageSag/Reported
[PREFIX]/ElectricalMeasurement/Attributes/RMSVoltageSag/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster RMSVoltageSag Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RMSVoltageSag attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/RMSVoltageSag/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSVoltageSag/Desired { "value": <DESIRED_RMS_VOLTAGE_SAG>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSVoltageSag/Reported { "value": <REPORTED_RMS_VOLTAGE_SAG>}

\subsection electrical_measurement_attr_rms_voltage_swell ElectricalMeasurement/RMSVoltageSwell Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/RMSVoltageSwell/Reported
[PREFIX]/ElectricalMeasurement/Attributes/RMSVoltageSwell/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster RMSVoltageSwell Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RMSVoltageSwell attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/RMSVoltageSwell/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSVoltageSwell/Desired { "value": <DESIRED_RMS_VOLTAGE_SWELL>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSVoltageSwell/Reported { "value": <REPORTED_RMS_VOLTAGE_SWELL>}

\subsection electrical_measurement_attr_line_current_phb ElectricalMeasurement/LineCurrentPhB Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/LineCurrentPhB/Reported
[PREFIX]/ElectricalMeasurement/Attributes/LineCurrentPhB/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster LineCurrentPhB Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for LineCurrentPhB attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/LineCurrentPhB/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/LineCurrentPhB/Desired { "value": <DESIRED_LINE_CURRENT_PHB>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/LineCurrentPhB/Reported { "value": <REPORTED_LINE_CURRENT_PHB>}

\subsection electrical_measurement_attr_active_current_phb ElectricalMeasurement/ActiveCurrentPhB Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/ActiveCurrentPhB/Reported
[PREFIX]/ElectricalMeasurement/Attributes/ActiveCurrentPhB/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster ActiveCurrentPhB Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ActiveCurrentPhB attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/ActiveCurrentPhB/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ActiveCurrentPhB/Desired { "value": <DESIRED_ACTIVE_CURRENT_PHB>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ActiveCurrentPhB/Reported { "value": <REPORTED_ACTIVE_CURRENT_PHB>}

\subsection electrical_measurement_attr_reactive_current_phb ElectricalMeasurement/ReactiveCurrentPhB Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/ReactiveCurrentPhB/Reported
[PREFIX]/ElectricalMeasurement/Attributes/ReactiveCurrentPhB/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster ReactiveCurrentPhB Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ReactiveCurrentPhB attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/ReactiveCurrentPhB/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ReactiveCurrentPhB/Desired { "value": <DESIRED_REACTIVE_CURRENT_PHB>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ReactiveCurrentPhB/Reported { "value": <REPORTED_REACTIVE_CURRENT_PHB>}

\subsection electrical_measurement_attr_rms_voltage_phb ElectricalMeasurement/RMSVoltagePhB Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/RMSVoltagePhB/Reported
[PREFIX]/ElectricalMeasurement/Attributes/RMSVoltagePhB/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster RMSVoltagePhB Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RMSVoltagePhB attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/RMSVoltagePhB/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSVoltagePhB/Desired { "value": <DESIRED_RMS_VOLTAGE_PHB>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSVoltagePhB/Reported { "value": <REPORTED_RMS_VOLTAGE_PHB>}

\subsection electrical_measurement_attr_rms_voltage_min_phb ElectricalMeasurement/RMSVoltageMinPhB Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/RMSVoltageMinPhB/Reported
[PREFIX]/ElectricalMeasurement/Attributes/RMSVoltageMinPhB/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster RMSVoltageMinPhB Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RMSVoltageMinPhB attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/RMSVoltageMinPhB/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSVoltageMinPhB/Desired { "value": <DESIRED_RMS_VOLTAGE_MIN_PHB>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSVoltageMinPhB/Reported { "value": <REPORTED_RMS_VOLTAGE_MIN_PHB>}

\subsection electrical_measurement_attr_rms_voltage_max_phb ElectricalMeasurement/RMSVoltageMaxPhB Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/RMSVoltageMaxPhB/Reported
[PREFIX]/ElectricalMeasurement/Attributes/RMSVoltageMaxPhB/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster RMSVoltageMaxPhB Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RMSVoltageMaxPhB attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/RMSVoltageMaxPhB/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSVoltageMaxPhB/Desired { "value": <DESIRED_RMS_VOLTAGE_MAX_PHB>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSVoltageMaxPhB/Reported { "value": <REPORTED_RMS_VOLTAGE_MAX_PHB>}

\subsection electrical_measurement_attr_rms_current_phb ElectricalMeasurement/RMSCurrentPhB Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/RMSCurrentPhB/Reported
[PREFIX]/ElectricalMeasurement/Attributes/RMSCurrentPhB/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster RMSCurrentPhB Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RMSCurrentPhB attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/RMSCurrentPhB/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSCurrentPhB/Desired { "value": <DESIRED_RMS_CURRENT_PHB>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSCurrentPhB/Reported { "value": <REPORTED_RMS_CURRENT_PHB>}

\subsection electrical_measurement_attr_rms_current_min_phb ElectricalMeasurement/RMSCurrentMinPhB Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/RMSCurrentMinPhB/Reported
[PREFIX]/ElectricalMeasurement/Attributes/RMSCurrentMinPhB/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster RMSCurrentMinPhB Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RMSCurrentMinPhB attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/RMSCurrentMinPhB/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSCurrentMinPhB/Desired { "value": <DESIRED_RMS_CURRENT_MIN_PHB>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSCurrentMinPhB/Reported { "value": <REPORTED_RMS_CURRENT_MIN_PHB>}

\subsection electrical_measurement_attr_rms_current_max_phb ElectricalMeasurement/RMSCurrentMaxPhB Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/RMSCurrentMaxPhB/Reported
[PREFIX]/ElectricalMeasurement/Attributes/RMSCurrentMaxPhB/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster RMSCurrentMaxPhB Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RMSCurrentMaxPhB attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/RMSCurrentMaxPhB/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSCurrentMaxPhB/Desired { "value": <DESIRED_RMS_CURRENT_MAX_PHB>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSCurrentMaxPhB/Reported { "value": <REPORTED_RMS_CURRENT_MAX_PHB>}

\subsection electrical_measurement_attr_active_power_phb ElectricalMeasurement/ActivePowerPhB Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/ActivePowerPhB/Reported
[PREFIX]/ElectricalMeasurement/Attributes/ActivePowerPhB/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster ActivePowerPhB Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ActivePowerPhB attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/ActivePowerPhB/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ActivePowerPhB/Desired { "value": <DESIRED_ACTIVE_POWER_PHB>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ActivePowerPhB/Reported { "value": <REPORTED_ACTIVE_POWER_PHB>}

\subsection electrical_measurement_attr_active_power_min_phb ElectricalMeasurement/ActivePowerMinPhB Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/ActivePowerMinPhB/Reported
[PREFIX]/ElectricalMeasurement/Attributes/ActivePowerMinPhB/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster ActivePowerMinPhB Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ActivePowerMinPhB attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/ActivePowerMinPhB/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ActivePowerMinPhB/Desired { "value": <DESIRED_ACTIVE_POWER_MIN_PHB>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ActivePowerMinPhB/Reported { "value": <REPORTED_ACTIVE_POWER_MIN_PHB>}

\subsection electrical_measurement_attr_active_power_max_phb ElectricalMeasurement/ActivePowerMaxPhB Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/ActivePowerMaxPhB/Reported
[PREFIX]/ElectricalMeasurement/Attributes/ActivePowerMaxPhB/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster ActivePowerMaxPhB Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ActivePowerMaxPhB attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/ActivePowerMaxPhB/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ActivePowerMaxPhB/Desired { "value": <DESIRED_ACTIVE_POWER_MAX_PHB>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ActivePowerMaxPhB/Reported { "value": <REPORTED_ACTIVE_POWER_MAX_PHB>}

\subsection electrical_measurement_attr_reactive_power_phb ElectricalMeasurement/ReactivePowerPhB Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/ReactivePowerPhB/Reported
[PREFIX]/ElectricalMeasurement/Attributes/ReactivePowerPhB/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster ReactivePowerPhB Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ReactivePowerPhB attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/ReactivePowerPhB/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ReactivePowerPhB/Desired { "value": <DESIRED_REACTIVE_POWER_PHB>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ReactivePowerPhB/Reported { "value": <REPORTED_REACTIVE_POWER_PHB>}

\subsection electrical_measurement_attr_apparent_power_phb ElectricalMeasurement/ApparentPowerPhB Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/ApparentPowerPhB/Reported
[PREFIX]/ElectricalMeasurement/Attributes/ApparentPowerPhB/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster ApparentPowerPhB Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ApparentPowerPhB attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/ApparentPowerPhB/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ApparentPowerPhB/Desired { "value": <DESIRED_APPARENT_POWER_PHB>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ApparentPowerPhB/Reported { "value": <REPORTED_APPARENT_POWER_PHB>}

\subsection electrical_measurement_attr_power_factor_phb ElectricalMeasurement/PowerFactorPhB Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/PowerFactorPhB/Reported
[PREFIX]/ElectricalMeasurement/Attributes/PowerFactorPhB/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster PowerFactorPhB Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for PowerFactorPhB attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/PowerFactorPhB/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/PowerFactorPhB/Desired { "value": <DESIRED_POWER_FACTOR_PHB>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/PowerFactorPhB/Reported { "value": <REPORTED_POWER_FACTOR_PHB>}

\subsection electrical_measurement_attr_average_rms_voltage_measurement_period_phb ElectricalMeasurement/AverageRMSVoltageMeasurementPeriodPhB Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/AverageRMSVoltageMeasurementPeriodPhB/Reported
[PREFIX]/ElectricalMeasurement/Attributes/AverageRMSVoltageMeasurementPeriodPhB/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster AverageRMSVoltageMeasurementPeriodPhB Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for AverageRMSVoltageMeasurementPeriodPhB attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/AverageRMSVoltageMeasurementPeriodPhB/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/AverageRMSVoltageMeasurementPeriodPhB/Desired { "value": <DESIRED_AVERAGE_RMS_VOLTAGE_MEASUREMENT_PERIOD_PHB>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/AverageRMSVoltageMeasurementPeriodPhB/Reported { "value": <REPORTED_AVERAGE_RMS_VOLTAGE_MEASUREMENT_PERIOD_PHB>}

\subsection electrical_measurement_attr_average_rms_over_voltage_counter_phb ElectricalMeasurement/AverageRMSOverVoltageCounterPhB Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/AverageRMSOverVoltageCounterPhB/Reported
[PREFIX]/ElectricalMeasurement/Attributes/AverageRMSOverVoltageCounterPhB/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster AverageRMSOverVoltageCounterPhB Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for AverageRMSOverVoltageCounterPhB attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/AverageRMSOverVoltageCounterPhB/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/AverageRMSOverVoltageCounterPhB/Desired { "value": <DESIRED_AVERAGE_RMS_OVER_VOLTAGE_COUNTER_PHB>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/AverageRMSOverVoltageCounterPhB/Reported { "value": <REPORTED_AVERAGE_RMS_OVER_VOLTAGE_COUNTER_PHB>}

\subsection electrical_measurement_attr_average_rms_under_voltage_counter_phb ElectricalMeasurement/AverageRMSUnderVoltageCounterPhB Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/AverageRMSUnderVoltageCounterPhB/Reported
[PREFIX]/ElectricalMeasurement/Attributes/AverageRMSUnderVoltageCounterPhB/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster AverageRMSUnderVoltageCounterPhB Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for AverageRMSUnderVoltageCounterPhB attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/AverageRMSUnderVoltageCounterPhB/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/AverageRMSUnderVoltageCounterPhB/Desired { "value": <DESIRED_AVERAGE_RMS_UNDER_VOLTAGE_COUNTER_PHB>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/AverageRMSUnderVoltageCounterPhB/Reported { "value": <REPORTED_AVERAGE_RMS_UNDER_VOLTAGE_COUNTER_PHB>}

\subsection electrical_measurement_attr_rms_extreme_over_voltage_period_phb ElectricalMeasurement/RMSExtremeOverVoltagePeriodPhB Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/RMSExtremeOverVoltagePeriodPhB/Reported
[PREFIX]/ElectricalMeasurement/Attributes/RMSExtremeOverVoltagePeriodPhB/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster RMSExtremeOverVoltagePeriodPhB Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RMSExtremeOverVoltagePeriodPhB attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/RMSExtremeOverVoltagePeriodPhB/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSExtremeOverVoltagePeriodPhB/Desired { "value": <DESIRED_RMS_EXTREME_OVER_VOLTAGE_PERIOD_PHB>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSExtremeOverVoltagePeriodPhB/Reported { "value": <REPORTED_RMS_EXTREME_OVER_VOLTAGE_PERIOD_PHB>}

\subsection electrical_measurement_attr_rms_extreme_under_voltage_period_phb ElectricalMeasurement/RMSExtremeUnderVoltagePeriodPhB Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/RMSExtremeUnderVoltagePeriodPhB/Reported
[PREFIX]/ElectricalMeasurement/Attributes/RMSExtremeUnderVoltagePeriodPhB/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster RMSExtremeUnderVoltagePeriodPhB Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RMSExtremeUnderVoltagePeriodPhB attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/RMSExtremeUnderVoltagePeriodPhB/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSExtremeUnderVoltagePeriodPhB/Desired { "value": <DESIRED_RMS_EXTREME_UNDER_VOLTAGE_PERIOD_PHB>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSExtremeUnderVoltagePeriodPhB/Reported { "value": <REPORTED_RMS_EXTREME_UNDER_VOLTAGE_PERIOD_PHB>}

\subsection electrical_measurement_attr_rms_voltage_sag_period_phb ElectricalMeasurement/RMSVoltageSagPeriodPhB Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/RMSVoltageSagPeriodPhB/Reported
[PREFIX]/ElectricalMeasurement/Attributes/RMSVoltageSagPeriodPhB/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster RMSVoltageSagPeriodPhB Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RMSVoltageSagPeriodPhB attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/RMSVoltageSagPeriodPhB/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSVoltageSagPeriodPhB/Desired { "value": <DESIRED_RMS_VOLTAGE_SAG_PERIOD_PHB>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSVoltageSagPeriodPhB/Reported { "value": <REPORTED_RMS_VOLTAGE_SAG_PERIOD_PHB>}

\subsection electrical_measurement_attr_rms_voltage_swell_period_phb ElectricalMeasurement/RMSVoltageSwellPeriodPhB Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/RMSVoltageSwellPeriodPhB/Reported
[PREFIX]/ElectricalMeasurement/Attributes/RMSVoltageSwellPeriodPhB/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster RMSVoltageSwellPeriodPhB Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RMSVoltageSwellPeriodPhB attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/RMSVoltageSwellPeriodPhB/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSVoltageSwellPeriodPhB/Desired { "value": <DESIRED_RMS_VOLTAGE_SWELL_PERIOD_PHB>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSVoltageSwellPeriodPhB/Reported { "value": <REPORTED_RMS_VOLTAGE_SWELL_PERIOD_PHB>}

\subsection electrical_measurement_attr_line_current_phc ElectricalMeasurement/LineCurrentPhC Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/LineCurrentPhC/Reported
[PREFIX]/ElectricalMeasurement/Attributes/LineCurrentPhC/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster LineCurrentPhC Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for LineCurrentPhC attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/LineCurrentPhC/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/LineCurrentPhC/Desired { "value": <DESIRED_LINE_CURRENT_PHC>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/LineCurrentPhC/Reported { "value": <REPORTED_LINE_CURRENT_PHC>}

\subsection electrical_measurement_attr_active_current_phc ElectricalMeasurement/ActiveCurrentPhC Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/ActiveCurrentPhC/Reported
[PREFIX]/ElectricalMeasurement/Attributes/ActiveCurrentPhC/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster ActiveCurrentPhC Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ActiveCurrentPhC attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/ActiveCurrentPhC/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ActiveCurrentPhC/Desired { "value": <DESIRED_ACTIVE_CURRENT_PHC>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ActiveCurrentPhC/Reported { "value": <REPORTED_ACTIVE_CURRENT_PHC>}

\subsection electrical_measurement_attr_reactive_current_phc ElectricalMeasurement/ReactiveCurrentPhC Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/ReactiveCurrentPhC/Reported
[PREFIX]/ElectricalMeasurement/Attributes/ReactiveCurrentPhC/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster ReactiveCurrentPhC Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ReactiveCurrentPhC attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/ReactiveCurrentPhC/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ReactiveCurrentPhC/Desired { "value": <DESIRED_REACTIVE_CURRENT_PHC>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ReactiveCurrentPhC/Reported { "value": <REPORTED_REACTIVE_CURRENT_PHC>}

\subsection electrical_measurement_attr_rms_voltage_phc ElectricalMeasurement/RMSVoltagePhC Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/RMSVoltagePhC/Reported
[PREFIX]/ElectricalMeasurement/Attributes/RMSVoltagePhC/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster RMSVoltagePhC Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RMSVoltagePhC attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/RMSVoltagePhC/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSVoltagePhC/Desired { "value": <DESIRED_RMS_VOLTAGE_PHC>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSVoltagePhC/Reported { "value": <REPORTED_RMS_VOLTAGE_PHC>}

\subsection electrical_measurement_attr_rms_voltage_min_phc ElectricalMeasurement/RMSVoltageMinPhC Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/RMSVoltageMinPhC/Reported
[PREFIX]/ElectricalMeasurement/Attributes/RMSVoltageMinPhC/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster RMSVoltageMinPhC Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RMSVoltageMinPhC attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/RMSVoltageMinPhC/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSVoltageMinPhC/Desired { "value": <DESIRED_RMS_VOLTAGE_MIN_PHC>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSVoltageMinPhC/Reported { "value": <REPORTED_RMS_VOLTAGE_MIN_PHC>}

\subsection electrical_measurement_attr_rms_voltage_max_phc ElectricalMeasurement/RMSVoltageMaxPhC Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/RMSVoltageMaxPhC/Reported
[PREFIX]/ElectricalMeasurement/Attributes/RMSVoltageMaxPhC/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster RMSVoltageMaxPhC Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RMSVoltageMaxPhC attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/RMSVoltageMaxPhC/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSVoltageMaxPhC/Desired { "value": <DESIRED_RMS_VOLTAGE_MAX_PHC>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSVoltageMaxPhC/Reported { "value": <REPORTED_RMS_VOLTAGE_MAX_PHC>}

\subsection electrical_measurement_attr_rms_current_phc ElectricalMeasurement/RMSCurrentPhC Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/RMSCurrentPhC/Reported
[PREFIX]/ElectricalMeasurement/Attributes/RMSCurrentPhC/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster RMSCurrentPhC Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RMSCurrentPhC attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/RMSCurrentPhC/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSCurrentPhC/Desired { "value": <DESIRED_RMS_CURRENT_PHC>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSCurrentPhC/Reported { "value": <REPORTED_RMS_CURRENT_PHC>}

\subsection electrical_measurement_attr_rms_current_min_phc ElectricalMeasurement/RMSCurrentMinPhC Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/RMSCurrentMinPhC/Reported
[PREFIX]/ElectricalMeasurement/Attributes/RMSCurrentMinPhC/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster RMSCurrentMinPhC Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RMSCurrentMinPhC attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/RMSCurrentMinPhC/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSCurrentMinPhC/Desired { "value": <DESIRED_RMS_CURRENT_MIN_PHC>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSCurrentMinPhC/Reported { "value": <REPORTED_RMS_CURRENT_MIN_PHC>}

\subsection electrical_measurement_attr_rms_current_max_phc ElectricalMeasurement/RMSCurrentMaxPhC Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/RMSCurrentMaxPhC/Reported
[PREFIX]/ElectricalMeasurement/Attributes/RMSCurrentMaxPhC/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster RMSCurrentMaxPhC Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RMSCurrentMaxPhC attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/RMSCurrentMaxPhC/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSCurrentMaxPhC/Desired { "value": <DESIRED_RMS_CURRENT_MAX_PHC>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSCurrentMaxPhC/Reported { "value": <REPORTED_RMS_CURRENT_MAX_PHC>}

\subsection electrical_measurement_attr_active_power_phc ElectricalMeasurement/ActivePowerPhC Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/ActivePowerPhC/Reported
[PREFIX]/ElectricalMeasurement/Attributes/ActivePowerPhC/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster ActivePowerPhC Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ActivePowerPhC attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/ActivePowerPhC/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ActivePowerPhC/Desired { "value": <DESIRED_ACTIVE_POWER_PHC>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ActivePowerPhC/Reported { "value": <REPORTED_ACTIVE_POWER_PHC>}

\subsection electrical_measurement_attr_active_power_min_phc ElectricalMeasurement/ActivePowerMinPhC Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/ActivePowerMinPhC/Reported
[PREFIX]/ElectricalMeasurement/Attributes/ActivePowerMinPhC/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster ActivePowerMinPhC Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ActivePowerMinPhC attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/ActivePowerMinPhC/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ActivePowerMinPhC/Desired { "value": <DESIRED_ACTIVE_POWER_MIN_PHC>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ActivePowerMinPhC/Reported { "value": <REPORTED_ACTIVE_POWER_MIN_PHC>}

\subsection electrical_measurement_attr_active_power_max_phc ElectricalMeasurement/ActivePowerMaxPhC Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/ActivePowerMaxPhC/Reported
[PREFIX]/ElectricalMeasurement/Attributes/ActivePowerMaxPhC/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster ActivePowerMaxPhC Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ActivePowerMaxPhC attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/ActivePowerMaxPhC/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ActivePowerMaxPhC/Desired { "value": <DESIRED_ACTIVE_POWER_MAX_PHC>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ActivePowerMaxPhC/Reported { "value": <REPORTED_ACTIVE_POWER_MAX_PHC>}

\subsection electrical_measurement_attr_reactive_power_phc ElectricalMeasurement/ReactivePowerPhC Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/ReactivePowerPhC/Reported
[PREFIX]/ElectricalMeasurement/Attributes/ReactivePowerPhC/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster ReactivePowerPhC Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ReactivePowerPhC attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/ReactivePowerPhC/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ReactivePowerPhC/Desired { "value": <DESIRED_REACTIVE_POWER_PHC>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ReactivePowerPhC/Reported { "value": <REPORTED_REACTIVE_POWER_PHC>}

\subsection electrical_measurement_attr_apparent_power_phc ElectricalMeasurement/ApparentPowerPhC Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/ApparentPowerPhC/Reported
[PREFIX]/ElectricalMeasurement/Attributes/ApparentPowerPhC/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster ApparentPowerPhC Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ApparentPowerPhC attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/ApparentPowerPhC/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ApparentPowerPhC/Desired { "value": <DESIRED_APPARENT_POWER_PHC>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/ApparentPowerPhC/Reported { "value": <REPORTED_APPARENT_POWER_PHC>}

\subsection electrical_measurement_attr_power_factor_phc ElectricalMeasurement/PowerFactorPhC Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/PowerFactorPhC/Reported
[PREFIX]/ElectricalMeasurement/Attributes/PowerFactorPhC/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster PowerFactorPhC Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for PowerFactorPhC attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/PowerFactorPhC/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/PowerFactorPhC/Desired { "value": <DESIRED_POWER_FACTOR_PHC>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/PowerFactorPhC/Reported { "value": <REPORTED_POWER_FACTOR_PHC>}

\subsection electrical_measurement_attr_average_rms_voltage_measurement_period_phc ElectricalMeasurement/AverageRMSVoltageMeasurementPeriodPhC Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/AverageRMSVoltageMeasurementPeriodPhC/Reported
[PREFIX]/ElectricalMeasurement/Attributes/AverageRMSVoltageMeasurementPeriodPhC/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster AverageRMSVoltageMeasurementPeriodPhC Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for AverageRMSVoltageMeasurementPeriodPhC attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/AverageRMSVoltageMeasurementPeriodPhC/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/AverageRMSVoltageMeasurementPeriodPhC/Desired { "value": <DESIRED_AVERAGE_RMS_VOLTAGE_MEASUREMENT_PERIOD_PHC>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/AverageRMSVoltageMeasurementPeriodPhC/Reported { "value": <REPORTED_AVERAGE_RMS_VOLTAGE_MEASUREMENT_PERIOD_PHC>}

\subsection electrical_measurement_attr_average_rms_over_voltage_counter_phc ElectricalMeasurement/AverageRMSOverVoltageCounterPhC Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/AverageRMSOverVoltageCounterPhC/Reported
[PREFIX]/ElectricalMeasurement/Attributes/AverageRMSOverVoltageCounterPhC/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster AverageRMSOverVoltageCounterPhC Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for AverageRMSOverVoltageCounterPhC attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/AverageRMSOverVoltageCounterPhC/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/AverageRMSOverVoltageCounterPhC/Desired { "value": <DESIRED_AVERAGE_RMS_OVER_VOLTAGE_COUNTER_PHC>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/AverageRMSOverVoltageCounterPhC/Reported { "value": <REPORTED_AVERAGE_RMS_OVER_VOLTAGE_COUNTER_PHC>}

\subsection electrical_measurement_attr_average_rms_under_voltage_counter_phc ElectricalMeasurement/AverageRMSUnderVoltageCounterPhC Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/AverageRMSUnderVoltageCounterPhC/Reported
[PREFIX]/ElectricalMeasurement/Attributes/AverageRMSUnderVoltageCounterPhC/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster AverageRMSUnderVoltageCounterPhC Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for AverageRMSUnderVoltageCounterPhC attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/AverageRMSUnderVoltageCounterPhC/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/AverageRMSUnderVoltageCounterPhC/Desired { "value": <DESIRED_AVERAGE_RMS_UNDER_VOLTAGE_COUNTER_PHC>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/AverageRMSUnderVoltageCounterPhC/Reported { "value": <REPORTED_AVERAGE_RMS_UNDER_VOLTAGE_COUNTER_PHC>}

\subsection electrical_measurement_attr_rms_extreme_over_voltage_period_phc ElectricalMeasurement/RMSExtremeOverVoltagePeriodPhC Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/RMSExtremeOverVoltagePeriodPhC/Reported
[PREFIX]/ElectricalMeasurement/Attributes/RMSExtremeOverVoltagePeriodPhC/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster RMSExtremeOverVoltagePeriodPhC Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RMSExtremeOverVoltagePeriodPhC attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/RMSExtremeOverVoltagePeriodPhC/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSExtremeOverVoltagePeriodPhC/Desired { "value": <DESIRED_RMS_EXTREME_OVER_VOLTAGE_PERIOD_PHC>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSExtremeOverVoltagePeriodPhC/Reported { "value": <REPORTED_RMS_EXTREME_OVER_VOLTAGE_PERIOD_PHC>}

\subsection electrical_measurement_attr_rms_extreme_under_voltage_period_phc ElectricalMeasurement/RMSExtremeUnderVoltagePeriodPhC Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/RMSExtremeUnderVoltagePeriodPhC/Reported
[PREFIX]/ElectricalMeasurement/Attributes/RMSExtremeUnderVoltagePeriodPhC/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster RMSExtremeUnderVoltagePeriodPhC Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RMSExtremeUnderVoltagePeriodPhC attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/RMSExtremeUnderVoltagePeriodPhC/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSExtremeUnderVoltagePeriodPhC/Desired { "value": <DESIRED_RMS_EXTREME_UNDER_VOLTAGE_PERIOD_PHC>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSExtremeUnderVoltagePeriodPhC/Reported { "value": <REPORTED_RMS_EXTREME_UNDER_VOLTAGE_PERIOD_PHC>}

\subsection electrical_measurement_attr_rms_voltage_sag_period_phc ElectricalMeasurement/RMSVoltageSagPeriodPhC Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/RMSVoltageSagPeriodPhC/Reported
[PREFIX]/ElectricalMeasurement/Attributes/RMSVoltageSagPeriodPhC/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster RMSVoltageSagPeriodPhC Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RMSVoltageSagPeriodPhC attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/RMSVoltageSagPeriodPhC/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSVoltageSagPeriodPhC/Desired { "value": <DESIRED_RMS_VOLTAGE_SAG_PERIOD_PHC>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSVoltageSagPeriodPhC/Reported { "value": <REPORTED_RMS_VOLTAGE_SAG_PERIOD_PHC>}

\subsection electrical_measurement_attr_rms_voltage_swell_period_phc ElectricalMeasurement/RMSVoltageSwellPeriodPhC Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/RMSVoltageSwellPeriodPhC/Reported
[PREFIX]/ElectricalMeasurement/Attributes/RMSVoltageSwellPeriodPhC/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster RMSVoltageSwellPeriodPhC Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RMSVoltageSwellPeriodPhC attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ElectricalMeasurement/Attributes/RMSVoltageSwellPeriodPhC/+'

# Example output

ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSVoltageSwellPeriodPhC/Desired { "value": <DESIRED_RMS_VOLTAGE_SWELL_PERIOD_PHC>}
ucl/by-unid/<UNID>/ep0/ElectricalMeasurement/Attributes/RMSVoltageSwellPeriodPhC/Reported { "value": <REPORTED_RMS_VOLTAGE_SWELL_PERIOD_PHC>}

\subsection electrical_measurement_attr_cluster_revision ElectricalMeasurement/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Attributes/ClusterRevision/Reported
[PREFIX]/ElectricalMeasurement/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ElectricalMeasurement/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/ElectricalMeasurement/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/ElectricalMeasurement/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section electrical_measurement_recv_cmd_support ElectricalMeasurement Command Support

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/SupportedCommands
[PREFIX]/ElectricalMeasurement/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
              "GetProfileInfoResponse",
              "GetProfileInfo",
              "GetMeasurementProfileResponse",
              "GetMeasurementProfile",
              "WriteAttributes",
              "ForceReadAttributes"
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for ElectricalMeasurement cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ElectricalMeasurement/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/ElectricalMeasurement/SupportedCommands { "value": ["GetProfileInfoResponse","GetMeasurementProfileResponse",] }

To see supported generated commands for ElectricalMeasurement cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ElectricalMeasurement/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/ElectricalMeasurement/SupportedGeneratedCommands { "value": ["GetProfileInfo","GetMeasurementProfile"] }

\section electrical_measurement_cmds ElectricalMeasurement Commands

\subsection electrical_measurement_get_profile_info_response_cmd ElectricalMeasurement/GetProfileInfoResponse Command

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Commands/GetProfileInfoResponse
[PREFIX]/ElectricalMeasurement/GeneratedCommands/GetProfileInfoResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster GetProfileInfoResponse Command Properties",
  "type": "object",
  "properties": {
    "ProfileCount": {
      "type": "integer"
    },
    "ProfileIntervalPeriod": {
      "type": "ProfileIntervalPeriod"
    },
    "MaxNumberOfIntervals": {
      "type": "integer"
    },
    "ListOfAttributes": {
      "type": "array",
      "items": {
        "type": "attribId"
      }

  },
  "required": [
    "ProfileCount",
    "ProfileIntervalPeriod",
    "MaxNumberOfIntervals",
    "ListOfAttributes"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ElectricalMeasurement/GetProfileInfoResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ElectricalMeasurement/Commands/GetProfileInfoResponse' -m  '{ "ProfileCount": <PROFILE_COUNT_VALUE>,"ProfileIntervalPeriod": <PROFILE_INTERVAL_PERIOD_VALUE>,"MaxNumberOfIntervals": <MAX_NUMBER_OF_INTERVALS_VALUE>,"ListOfAttributes": <LIST_OF_ATTRIBUTES_VALUE> }'

To receive a ElectricalMeasurement/GetProfileInfoResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ElectricalMeasurement/GeneratedCommands/GetProfileInfoResponse'

\subsection electrical_measurement_get_profile_info_cmd ElectricalMeasurement/GetProfileInfo Command

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Commands/GetProfileInfo
[PREFIX]/ElectricalMeasurement/GeneratedCommands/GetProfileInfo

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster GetProfileInfo Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
  ]
}

Example Mosquitto CLI Tool Usage

To send a ElectricalMeasurement/GetProfileInfo command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ElectricalMeasurement/Commands/GetProfileInfo' -m  '{  }'

To receive a ElectricalMeasurement/GetProfileInfo generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ElectricalMeasurement/GeneratedCommands/GetProfileInfo'

\subsection electrical_measurement_get_measurement_profile_response_cmd ElectricalMeasurement/GetMeasurementProfileResponse Command

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Commands/GetMeasurementProfileResponse
[PREFIX]/ElectricalMeasurement/GeneratedCommands/GetMeasurementProfileResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster GetMeasurementProfileResponse Command Properties",
  "type": "object",
  "properties": {
    "StartTime": {
      "type": "UTC"
    },
    "Status": {
      "type": "GetMeasurementProfileResponseStatus"
    },
    "ProfileIntervalPeriod": {
      "type": "ProfileIntervalPeriod"
    },
    "NumberOfIntervalsDelivered": {
      "type": "integer"
    },
    "AttributeId": {
      "type": "attribId"
    },
    "Intervals": {
      "type": "array",
      "items": {
        "type": "integer"
      }

  },
  "required": [
    "StartTime",
    "Status",
    "ProfileIntervalPeriod",
    "NumberOfIntervalsDelivered",
    "AttributeId",
    "Intervals"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ElectricalMeasurement/GetMeasurementProfileResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ElectricalMeasurement/Commands/GetMeasurementProfileResponse' -m  '{ "StartTime": <START_TIME_VALUE>,"Status": <STATUS_VALUE>,"ProfileIntervalPeriod": <PROFILE_INTERVAL_PERIOD_VALUE>,"NumberOfIntervalsDelivered": <NUMBER_OF_INTERVALS_DELIVERED_VALUE>,"AttributeId": <ATTRIBUTE_ID_VALUE>,"Intervals": <INTERVALS_VALUE> }'

To receive a ElectricalMeasurement/GetMeasurementProfileResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ElectricalMeasurement/GeneratedCommands/GetMeasurementProfileResponse'

\subsection electrical_measurement_get_measurement_profile_cmd ElectricalMeasurement/GetMeasurementProfile Command

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Commands/GetMeasurementProfile
[PREFIX]/ElectricalMeasurement/GeneratedCommands/GetMeasurementProfile

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster GetMeasurementProfile Command Properties",
  "type": "object",
  "properties": {
    "AttributeID": {
      "type": "attribId"
    },
    "StartTime": {
      "type": "UTC"
    },
    "NumberOfIntervals": {
      "type": "integer"
    }
  },
  "required": [
    "AttributeID",
    "StartTime",
    "NumberOfIntervals"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ElectricalMeasurement/GetMeasurementProfile command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ElectricalMeasurement/Commands/GetMeasurementProfile' -m  '{ "AttributeID": <ATTRIBUTEID_VALUE>,"StartTime": <START_TIME_VALUE>,"NumberOfIntervals": <NUMBER_OF_INTERVALS_VALUE> }'

To receive a ElectricalMeasurement/GetMeasurementProfile generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ElectricalMeasurement/GeneratedCommands/GetMeasurementProfile'

\subsection electrical_measurement_write_attr_cmd ElectricalMeasurement/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
    "AverageRMSVoltageMeasurementPeriod": {
      "type": "integer"
    },
    "AverageRMSOverVoltageCounter": {
      "type": "integer"
    },
    "AverageRMSUnderVoltageCounter": {
      "type": "integer"
    },
    "RMSExtremeOverVoltagePeriod": {
      "type": "integer"
    },
    "RMSExtremeUnderVoltagePeriod": {
      "type": "integer"
    },
    "RMSVoltageSagPeriod": {
      "type": "integer"
    },
    "RMSVoltageSwellPeriod": {
      "type": "integer"
    },
    "DCOverloadAlarmsMask": {
      "type": "ElectricalMeasurementDCOverloadAlarmsMask"
    },
    "ACAlarmsMask": {
      "type": "ElectricalMeasurementACAlarmsMask"
    },
    "RMSExtremeOverVoltage": {
      "type": "integer"
    },
    "RMSExtremeUnderVoltage": {
      "type": "integer"
    },
    "RMSVoltageSag": {
      "type": "integer"
    },
    "RMSVoltageSwell": {
      "type": "integer"
    },
    "AverageRMSVoltageMeasurementPeriodPhB": {
      "type": "integer"
    },
    "AverageRMSOverVoltageCounterPhB": {
      "type": "integer"
    },
    "AverageRMSUnderVoltageCounterPhB": {
      "type": "integer"
    },
    "RMSExtremeOverVoltagePeriodPhB": {
      "type": "integer"
    },
    "RMSExtremeUnderVoltagePeriodPhB": {
      "type": "integer"
    },
    "RMSVoltageSagPeriodPhB": {
      "type": "integer"
    },
    "RMSVoltageSwellPeriodPhB": {
      "type": "integer"
    },
    "AverageRMSVoltageMeasurementPeriodPhC": {
      "type": "integer"
    },
    "AverageRMSOverVoltageCounterPhC": {
      "type": "integer"
    },
    "AverageRMSUnderVoltageCounterPhC": {
      "type": "integer"
    },
    "RMSExtremeOverVoltagePeriodPhC": {
      "type": "integer"
    },
    "RMSExtremeUnderVoltagePeriodPhC": {
      "type": "integer"
    },
    "RMSVoltageSagPeriodPhC": {
      "type": "integer"
    },
    "RMSVoltageSwellPeriodPhC": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all ElectricalMeasurement attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ElectricalMeasurement/Commands/WriteAttributes' -m  '{ "AverageRMSVoltageMeasurementPeriod": <AVERAGE_RMS_VOLTAGE_MEASUREMENT_PERIOD_VALUE> ,"AverageRMSOverVoltageCounter": <AVERAGE_RMS_OVER_VOLTAGE_COUNTER_VALUE> ,"AverageRMSUnderVoltageCounter": <AVERAGE_RMS_UNDER_VOLTAGE_COUNTER_VALUE> ,"RMSExtremeOverVoltagePeriod": <RMS_EXTREME_OVER_VOLTAGE_PERIOD_VALUE> ,"RMSExtremeUnderVoltagePeriod": <RMS_EXTREME_UNDER_VOLTAGE_PERIOD_VALUE> ,"RMSVoltageSagPeriod": <RMS_VOLTAGE_SAG_PERIOD_VALUE> ,"RMSVoltageSwellPeriod": <RMS_VOLTAGE_SWELL_PERIOD_VALUE> ,"DCOverloadAlarmsMask": <DC_OVERLOAD_ALARMS_MASK_VALUE> ,"ACAlarmsMask": <AC_ALARMS_MASK_VALUE> ,"RMSExtremeOverVoltage": <RMS_EXTREME_OVER_VOLTAGE_VALUE> ,"RMSExtremeUnderVoltage": <RMS_EXTREME_UNDER_VOLTAGE_VALUE> ,"RMSVoltageSag": <RMS_VOLTAGE_SAG_VALUE> ,"RMSVoltageSwell": <RMS_VOLTAGE_SWELL_VALUE> ,"AverageRMSVoltageMeasurementPeriodPhB": <AVERAGE_RMS_VOLTAGE_MEASUREMENT_PERIOD_PHB_VALUE> ,"AverageRMSOverVoltageCounterPhB": <AVERAGE_RMS_OVER_VOLTAGE_COUNTER_PHB_VALUE> ,"AverageRMSUnderVoltageCounterPhB": <AVERAGE_RMS_UNDER_VOLTAGE_COUNTER_PHB_VALUE> ,"RMSExtremeOverVoltagePeriodPhB": <RMS_EXTREME_OVER_VOLTAGE_PERIOD_PHB_VALUE> ,"RMSExtremeUnderVoltagePeriodPhB": <RMS_EXTREME_UNDER_VOLTAGE_PERIOD_PHB_VALUE> ,"RMSVoltageSagPeriodPhB": <RMS_VOLTAGE_SAG_PERIOD_PHB_VALUE> ,"RMSVoltageSwellPeriodPhB": <RMS_VOLTAGE_SWELL_PERIOD_PHB_VALUE> ,"AverageRMSVoltageMeasurementPeriodPhC": <AVERAGE_RMS_VOLTAGE_MEASUREMENT_PERIOD_PHC_VALUE> ,"AverageRMSOverVoltageCounterPhC": <AVERAGE_RMS_OVER_VOLTAGE_COUNTER_PHC_VALUE> ,"AverageRMSUnderVoltageCounterPhC": <AVERAGE_RMS_UNDER_VOLTAGE_COUNTER_PHC_VALUE> ,"RMSExtremeOverVoltagePeriodPhC": <RMS_EXTREME_OVER_VOLTAGE_PERIOD_PHC_VALUE> ,"RMSExtremeUnderVoltagePeriodPhC": <RMS_EXTREME_UNDER_VOLTAGE_PERIOD_PHC_VALUE> ,"RMSVoltageSagPeriodPhC": <RMS_VOLTAGE_SAG_PERIOD_PHC_VALUE> ,"RMSVoltageSwellPeriodPhC": <RMS_VOLTAGE_SWELL_PERIOD_PHC_VALUE>  }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection electrical_measurement_force_read_attr_cmd ElectricalMeasurement/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/ElectricalMeasurement/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurement Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "MeasurementType",
          "DCVoltage",
          "DCVoltageMin",
          "DCVoltageMax",
          "DCCurrent",
          "DCCurrentMin",
          "DCCurrentMax",
          "DCPower",
          "DCPowerMin",
          "DCPowerMax",
          "DCVoltageMultiplier",
          "DCVoltageDivisor",
          "DCCurrentMultiplier",
          "DCCurrentDivisor",
          "DCPowerMultiplier",
          "DCPowerDivisor",
          "ACFrequency",
          "ACFrequencyMin",
          "ACFrequencyMax",
          "NeutralCurrent",
          "TotalActivePower",
          "TotalReactivePower",
          "TotalApparentPower",
          "Measured1stHarmonicCurrent",
          "Measured3rdHarmonicCurrent",
          "Measured5thHarmonicCurrent",
          "Measured7thHarmonicCurrent",
          "Measured9thHarmonicCurrent",
          "Measured11thHarmonicCurrent",
          "MeasuredPhase1stHarmonicCurrent",
          "MeasuredPhase3rdHarmonicCurrent",
          "MeasuredPhase5thHarmonicCurrent",
          "MeasuredPhase7thHarmonicCurrent",
          "MeasuredPhase9thHarmonicCurrent",
          "MeasuredPhase11thHarmonicCurrent",
          "ACFrequencyMultiplier",
          "ACFrequencyDivisor",
          "PowerMultiplier",
          "PowerDivisor",
          "HarmonicCurrentMultiplier",
          "PhaseHarmonicCurrentMultiplier",
          "LineCurrent",
          "ActiveCurrent",
          "ReactiveCurrent",
          "RMSVoltage",
          "RMSVoltageMin",
          "RMSVoltageMax",
          "RMSCurrent",
          "RMSCurrentMin",
          "RMSCurrentMax",
          "ActivePower",
          "ActivePowerMin",
          "ActivePowerMax",
          "ReactivePower",
          "ApparentPower",
          "PowerFactor",
          "AverageRMSVoltageMeasurementPeriod",
          "AverageRMSOverVoltageCounter",
          "AverageRMSUnderVoltageCounter",
          "RMSExtremeOverVoltagePeriod",
          "RMSExtremeUnderVoltagePeriod",
          "RMSVoltageSagPeriod",
          "RMSVoltageSwellPeriod",
          "ACVoltageMultiplier",
          "ACVoltageDivisor",
          "ACCurrentMultiplier",
          "ACCurrentDivisor",
          "ACPowerMultiplier",
          "ACPowerDivisor",
          "DCOverloadAlarmsMask",
          "DCVoltageOverload",
          "DCCurrentOverload",
          "ACAlarmsMask",
          "ACVoltageOverload",
          "ACCurrentOverload",
          "ACActivePowerOverload",
          "ACReactivePowerOverload",
          "AverageRMSOverVoltage",
          "AverageRMSUnderVoltage",
          "RMSExtremeOverVoltage",
          "RMSExtremeUnderVoltage",
          "RMSVoltageSag",
          "RMSVoltageSwell",
          "LineCurrentPhB",
          "ActiveCurrentPhB",
          "ReactiveCurrentPhB",
          "RMSVoltagePhB",
          "RMSVoltageMinPhB",
          "RMSVoltageMaxPhB",
          "RMSCurrentPhB",
          "RMSCurrentMinPhB",
          "RMSCurrentMaxPhB",
          "ActivePowerPhB",
          "ActivePowerMinPhB",
          "ActivePowerMaxPhB",
          "ReactivePowerPhB",
          "ApparentPowerPhB",
          "PowerFactorPhB",
          "AverageRMSVoltageMeasurementPeriodPhB",
          "AverageRMSOverVoltageCounterPhB",
          "AverageRMSUnderVoltageCounterPhB",
          "RMSExtremeOverVoltagePeriodPhB",
          "RMSExtremeUnderVoltagePeriodPhB",
          "RMSVoltageSagPeriodPhB",
          "RMSVoltageSwellPeriodPhB",
          "LineCurrentPhC",
          "ActiveCurrentPhC",
          "ReactiveCurrentPhC",
          "RMSVoltagePhC",
          "RMSVoltageMinPhC",
          "RMSVoltageMaxPhC",
          "RMSCurrentPhC",
          "RMSCurrentMinPhC",
          "RMSCurrentMaxPhC",
          "ActivePowerPhC",
          "ActivePowerMinPhC",
          "ActivePowerMaxPhC",
          "ReactivePowerPhC",
          "ApparentPowerPhC",
          "PowerFactorPhC",
          "AverageRMSVoltageMeasurementPeriodPhC",
          "AverageRMSOverVoltageCounterPhC",
          "AverageRMSUnderVoltageCounterPhC",
          "RMSExtremeOverVoltagePeriodPhC",
          "RMSExtremeUnderVoltagePeriodPhC",
          "RMSVoltageSagPeriodPhC",
          "RMSVoltageSwellPeriodPhC"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all ElectricalMeasurement attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ElectricalMeasurement/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the ElectricalMeasurement attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ElectricalMeasurement/Commands/ForceReadAttributes' -m  '{ "value": ["MeasurementType"] }'

\page diagnostics Diagnostics Cluster The following commands and attributes are accepted as JSON payloads for the Diagnostics cluster.

\section diagnostics_attrs Diagnostics Attributes The following attribute topics are used to retrieve the Diagnostics cluster state.

\subsection diagnostics_attr_number_of_resets Diagnostics/NumberOfResets Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/NumberOfResets/Reported
[PREFIX]/Diagnostics/Attributes/NumberOfResets/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Diagnostics Cluster NumberOfResets Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for NumberOfResets attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/NumberOfResets/+'

# Example output

ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/NumberOfResets/Desired { "value": <DESIRED_NUMBER_OF_RESETS>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/NumberOfResets/Reported { "value": <REPORTED_NUMBER_OF_RESETS>}

\subsection diagnostics_attr_persistent_memory_writes Diagnostics/PersistentMemoryWrites Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/PersistentMemoryWrites/Reported
[PREFIX]/Diagnostics/Attributes/PersistentMemoryWrites/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Diagnostics Cluster PersistentMemoryWrites Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for PersistentMemoryWrites attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/PersistentMemoryWrites/+'

# Example output

ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/PersistentMemoryWrites/Desired { "value": <DESIRED_PERSISTENT_MEMORY_WRITES>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/PersistentMemoryWrites/Reported { "value": <REPORTED_PERSISTENT_MEMORY_WRITES>}

\subsection diagnostics_attr_mac_rx_bcast Diagnostics/MacRxBcast Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/MacRxBcast/Reported
[PREFIX]/Diagnostics/Attributes/MacRxBcast/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Diagnostics Cluster MacRxBcast Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MacRxBcast attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/MacRxBcast/+'

# Example output

ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/MacRxBcast/Desired { "value": <DESIRED_MAC_RX_BCAST>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/MacRxBcast/Reported { "value": <REPORTED_MAC_RX_BCAST>}

\subsection diagnostics_attr_mac_tx_bcast Diagnostics/MacTxBcast Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/MacTxBcast/Reported
[PREFIX]/Diagnostics/Attributes/MacTxBcast/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Diagnostics Cluster MacTxBcast Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MacTxBcast attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/MacTxBcast/+'

# Example output

ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/MacTxBcast/Desired { "value": <DESIRED_MAC_TX_BCAST>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/MacTxBcast/Reported { "value": <REPORTED_MAC_TX_BCAST>}

\subsection diagnostics_attr_mac_rx_ucast Diagnostics/MacRxUcast Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/MacRxUcast/Reported
[PREFIX]/Diagnostics/Attributes/MacRxUcast/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Diagnostics Cluster MacRxUcast Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MacRxUcast attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/MacRxUcast/+'

# Example output

ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/MacRxUcast/Desired { "value": <DESIRED_MAC_RX_UCAST>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/MacRxUcast/Reported { "value": <REPORTED_MAC_RX_UCAST>}

\subsection diagnostics_attr_mac_tx_ucast Diagnostics/MacTxUcast Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/MacTxUcast/Reported
[PREFIX]/Diagnostics/Attributes/MacTxUcast/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Diagnostics Cluster MacTxUcast Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MacTxUcast attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/MacTxUcast/+'

# Example output

ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/MacTxUcast/Desired { "value": <DESIRED_MAC_TX_UCAST>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/MacTxUcast/Reported { "value": <REPORTED_MAC_TX_UCAST>}

\subsection diagnostics_attr_mac_tx_ucast_retry Diagnostics/MacTxUcastRetry Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/MacTxUcastRetry/Reported
[PREFIX]/Diagnostics/Attributes/MacTxUcastRetry/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Diagnostics Cluster MacTxUcastRetry Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MacTxUcastRetry attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/MacTxUcastRetry/+'

# Example output

ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/MacTxUcastRetry/Desired { "value": <DESIRED_MAC_TX_UCAST_RETRY>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/MacTxUcastRetry/Reported { "value": <REPORTED_MAC_TX_UCAST_RETRY>}

\subsection diagnostics_attr_mac_tx_ucast_fail Diagnostics/MacTxUcastFail Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/MacTxUcastFail/Reported
[PREFIX]/Diagnostics/Attributes/MacTxUcastFail/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Diagnostics Cluster MacTxUcastFail Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MacTxUcastFail attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/MacTxUcastFail/+'

# Example output

ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/MacTxUcastFail/Desired { "value": <DESIRED_MAC_TX_UCAST_FAIL>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/MacTxUcastFail/Reported { "value": <REPORTED_MAC_TX_UCAST_FAIL>}

\subsection diagnostics_attr_aps_rx_bcast Diagnostics/APSRxBcast Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/APSRxBcast/Reported
[PREFIX]/Diagnostics/Attributes/APSRxBcast/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Diagnostics Cluster APSRxBcast Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for APSRxBcast attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/APSRxBcast/+'

# Example output

ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/APSRxBcast/Desired { "value": <DESIRED_APS_RX_BCAST>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/APSRxBcast/Reported { "value": <REPORTED_APS_RX_BCAST>}

\subsection diagnostics_attr_aps_tx_bcast Diagnostics/APSTxBcast Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/APSTxBcast/Reported
[PREFIX]/Diagnostics/Attributes/APSTxBcast/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Diagnostics Cluster APSTxBcast Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for APSTxBcast attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/APSTxBcast/+'

# Example output

ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/APSTxBcast/Desired { "value": <DESIRED_APS_TX_BCAST>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/APSTxBcast/Reported { "value": <REPORTED_APS_TX_BCAST>}

\subsection diagnostics_attr_aps_rx_ucast Diagnostics/APSRxUcast Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/APSRxUcast/Reported
[PREFIX]/Diagnostics/Attributes/APSRxUcast/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Diagnostics Cluster APSRxUcast Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for APSRxUcast attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/APSRxUcast/+'

# Example output

ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/APSRxUcast/Desired { "value": <DESIRED_APS_RX_UCAST>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/APSRxUcast/Reported { "value": <REPORTED_APS_RX_UCAST>}

\subsection diagnostics_attr_aps_tx_ucast_success Diagnostics/APSTxUcastSuccess Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/APSTxUcastSuccess/Reported
[PREFIX]/Diagnostics/Attributes/APSTxUcastSuccess/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Diagnostics Cluster APSTxUcastSuccess Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for APSTxUcastSuccess attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/APSTxUcastSuccess/+'

# Example output

ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/APSTxUcastSuccess/Desired { "value": <DESIRED_APS_TX_UCAST_SUCCESS>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/APSTxUcastSuccess/Reported { "value": <REPORTED_APS_TX_UCAST_SUCCESS>}

\subsection diagnostics_attr_aps_tx_ucast_retry Diagnostics/APSTxUcastRetry Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/APSTxUcastRetry/Reported
[PREFIX]/Diagnostics/Attributes/APSTxUcastRetry/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Diagnostics Cluster APSTxUcastRetry Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for APSTxUcastRetry attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/APSTxUcastRetry/+'

# Example output

ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/APSTxUcastRetry/Desired { "value": <DESIRED_APS_TX_UCAST_RETRY>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/APSTxUcastRetry/Reported { "value": <REPORTED_APS_TX_UCAST_RETRY>}

\subsection diagnostics_attr_aps_tx_ucast_fail Diagnostics/APSTxUcastFail Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/APSTxUcastFail/Reported
[PREFIX]/Diagnostics/Attributes/APSTxUcastFail/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Diagnostics Cluster APSTxUcastFail Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for APSTxUcastFail attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/APSTxUcastFail/+'

# Example output

ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/APSTxUcastFail/Desired { "value": <DESIRED_APS_TX_UCAST_FAIL>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/APSTxUcastFail/Reported { "value": <REPORTED_APS_TX_UCAST_FAIL>}

\subsection diagnostics_attr_route_disc_initiated Diagnostics/RouteDiscInitiated Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/RouteDiscInitiated/Reported
[PREFIX]/Diagnostics/Attributes/RouteDiscInitiated/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Diagnostics Cluster RouteDiscInitiated Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RouteDiscInitiated attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/RouteDiscInitiated/+'

# Example output

ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/RouteDiscInitiated/Desired { "value": <DESIRED_ROUTE_DISC_INITIATED>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/RouteDiscInitiated/Reported { "value": <REPORTED_ROUTE_DISC_INITIATED>}

\subsection diagnostics_attr_neighbor_added Diagnostics/NeighborAdded Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/NeighborAdded/Reported
[PREFIX]/Diagnostics/Attributes/NeighborAdded/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Diagnostics Cluster NeighborAdded Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for NeighborAdded attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/NeighborAdded/+'

# Example output

ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/NeighborAdded/Desired { "value": <DESIRED_NEIGHBOR_ADDED>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/NeighborAdded/Reported { "value": <REPORTED_NEIGHBOR_ADDED>}

\subsection diagnostics_attr_neighbor_removed Diagnostics/NeighborRemoved Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/NeighborRemoved/Reported
[PREFIX]/Diagnostics/Attributes/NeighborRemoved/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Diagnostics Cluster NeighborRemoved Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for NeighborRemoved attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/NeighborRemoved/+'

# Example output

ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/NeighborRemoved/Desired { "value": <DESIRED_NEIGHBOR_REMOVED>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/NeighborRemoved/Reported { "value": <REPORTED_NEIGHBOR_REMOVED>}

\subsection diagnostics_attr_neighbor_stale Diagnostics/NeighborStale Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/NeighborStale/Reported
[PREFIX]/Diagnostics/Attributes/NeighborStale/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Diagnostics Cluster NeighborStale Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for NeighborStale attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/NeighborStale/+'

# Example output

ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/NeighborStale/Desired { "value": <DESIRED_NEIGHBOR_STALE>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/NeighborStale/Reported { "value": <REPORTED_NEIGHBOR_STALE>}

\subsection diagnostics_attr_join_indication Diagnostics/JoinIndication Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/JoinIndication/Reported
[PREFIX]/Diagnostics/Attributes/JoinIndication/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Diagnostics Cluster JoinIndication Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for JoinIndication attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/JoinIndication/+'

# Example output

ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/JoinIndication/Desired { "value": <DESIRED_JOIN_INDICATION>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/JoinIndication/Reported { "value": <REPORTED_JOIN_INDICATION>}

\subsection diagnostics_attr_child_moved Diagnostics/ChildMoved Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/ChildMoved/Reported
[PREFIX]/Diagnostics/Attributes/ChildMoved/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Diagnostics Cluster ChildMoved Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ChildMoved attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/ChildMoved/+'

# Example output

ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/ChildMoved/Desired { "value": <DESIRED_CHILD_MOVED>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/ChildMoved/Reported { "value": <REPORTED_CHILD_MOVED>}

\subsection diagnostics_attr_nwkfc_failure Diagnostics/NWKFCFailure Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/NWKFCFailure/Reported
[PREFIX]/Diagnostics/Attributes/NWKFCFailure/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Diagnostics Cluster NWKFCFailure Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for NWKFCFailure attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/NWKFCFailure/+'

# Example output

ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/NWKFCFailure/Desired { "value": <DESIRED_NWKFC_FAILURE>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/NWKFCFailure/Reported { "value": <REPORTED_NWKFC_FAILURE>}

\subsection diagnostics_attr_apsfc_failure Diagnostics/APSFCFailure Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/APSFCFailure/Reported
[PREFIX]/Diagnostics/Attributes/APSFCFailure/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Diagnostics Cluster APSFCFailure Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for APSFCFailure attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/APSFCFailure/+'

# Example output

ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/APSFCFailure/Desired { "value": <DESIRED_APSFC_FAILURE>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/APSFCFailure/Reported { "value": <REPORTED_APSFC_FAILURE>}

\subsection diagnostics_attr_aps_unauthorized_key Diagnostics/APSUnauthorizedKey Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/APSUnauthorizedKey/Reported
[PREFIX]/Diagnostics/Attributes/APSUnauthorizedKey/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Diagnostics Cluster APSUnauthorizedKey Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for APSUnauthorizedKey attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/APSUnauthorizedKey/+'

# Example output

ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/APSUnauthorizedKey/Desired { "value": <DESIRED_APS_UNAUTHORIZED_KEY>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/APSUnauthorizedKey/Reported { "value": <REPORTED_APS_UNAUTHORIZED_KEY>}

\subsection diagnostics_attr_nwk_decrypt_failures Diagnostics/NWKDecryptFailures Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/NWKDecryptFailures/Reported
[PREFIX]/Diagnostics/Attributes/NWKDecryptFailures/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Diagnostics Cluster NWKDecryptFailures Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for NWKDecryptFailures attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/NWKDecryptFailures/+'

# Example output

ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/NWKDecryptFailures/Desired { "value": <DESIRED_NWK_DECRYPT_FAILURES>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/NWKDecryptFailures/Reported { "value": <REPORTED_NWK_DECRYPT_FAILURES>}

\subsection diagnostics_attr_aps_decrypt_failures Diagnostics/APSDecryptFailures Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/APSDecryptFailures/Reported
[PREFIX]/Diagnostics/Attributes/APSDecryptFailures/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Diagnostics Cluster APSDecryptFailures Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for APSDecryptFailures attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/APSDecryptFailures/+'

# Example output

ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/APSDecryptFailures/Desired { "value": <DESIRED_APS_DECRYPT_FAILURES>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/APSDecryptFailures/Reported { "value": <REPORTED_APS_DECRYPT_FAILURES>}

\subsection diagnostics_attr_packet_buffer_allocate_failures Diagnostics/PacketBufferAllocateFailures Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/PacketBufferAllocateFailures/Reported
[PREFIX]/Diagnostics/Attributes/PacketBufferAllocateFailures/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Diagnostics Cluster PacketBufferAllocateFailures Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for PacketBufferAllocateFailures attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/PacketBufferAllocateFailures/+'

# Example output

ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/PacketBufferAllocateFailures/Desired { "value": <DESIRED_PACKET_BUFFER_ALLOCATE_FAILURES>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/PacketBufferAllocateFailures/Reported { "value": <REPORTED_PACKET_BUFFER_ALLOCATE_FAILURES>}

\subsection diagnostics_attr_relayed_ucast Diagnostics/RelayedUcast Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/RelayedUcast/Reported
[PREFIX]/Diagnostics/Attributes/RelayedUcast/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Diagnostics Cluster RelayedUcast Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RelayedUcast attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/RelayedUcast/+'

# Example output

ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/RelayedUcast/Desired { "value": <DESIRED_RELAYED_UCAST>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/RelayedUcast/Reported { "value": <REPORTED_RELAYED_UCAST>}

\subsection diagnostics_attr_phy_to_mac_queue_limit_reached Diagnostics/PHYToMACQueueLimitReached Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/PHYToMACQueueLimitReached/Reported
[PREFIX]/Diagnostics/Attributes/PHYToMACQueueLimitReached/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Diagnostics Cluster PHYToMACQueueLimitReached Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for PHYToMACQueueLimitReached attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/PHYToMACQueueLimitReached/+'

# Example output

ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/PHYToMACQueueLimitReached/Desired { "value": <DESIRED_PHY_TO_MAC_QUEUE_LIMIT_REACHED>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/PHYToMACQueueLimitReached/Reported { "value": <REPORTED_PHY_TO_MAC_QUEUE_LIMIT_REACHED>}

\subsection diagnostics_attr_packet_validate_drop_count Diagnostics/PacketValidateDropCount Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/PacketValidateDropCount/Reported
[PREFIX]/Diagnostics/Attributes/PacketValidateDropCount/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Diagnostics Cluster PacketValidateDropCount Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for PacketValidateDropCount attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/PacketValidateDropCount/+'

# Example output

ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/PacketValidateDropCount/Desired { "value": <DESIRED_PACKET_VALIDATE_DROP_COUNT>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/PacketValidateDropCount/Reported { "value": <REPORTED_PACKET_VALIDATE_DROP_COUNT>}

\subsection diagnostics_attr_average_mac_retry_per_aps_message_sent Diagnostics/AverageMACRetryPerAPSMessageSent Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/AverageMACRetryPerAPSMessageSent/Reported
[PREFIX]/Diagnostics/Attributes/AverageMACRetryPerAPSMessageSent/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Diagnostics Cluster AverageMACRetryPerAPSMessageSent Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for AverageMACRetryPerAPSMessageSent attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/AverageMACRetryPerAPSMessageSent/+'

# Example output

ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/AverageMACRetryPerAPSMessageSent/Desired { "value": <DESIRED_AVERAGE_MAC_RETRY_PER_APS_MESSAGE_SENT>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/AverageMACRetryPerAPSMessageSent/Reported { "value": <REPORTED_AVERAGE_MAC_RETRY_PER_APS_MESSAGE_SENT>}

\subsection diagnostics_attr_last_messagelqi Diagnostics/LastMessageLQI Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/LastMessageLQI/Reported
[PREFIX]/Diagnostics/Attributes/LastMessageLQI/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Diagnostics Cluster LastMessageLQI Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for LastMessageLQI attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/LastMessageLQI/+'

# Example output

ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/LastMessageLQI/Desired { "value": <DESIRED_LAST_MESSAGELQI>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/LastMessageLQI/Reported { "value": <REPORTED_LAST_MESSAGELQI>}

\subsection diagnostics_attr_last_messagerssi Diagnostics/LastMessageRSSI Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/LastMessageRSSI/Reported
[PREFIX]/Diagnostics/Attributes/LastMessageRSSI/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Diagnostics Cluster LastMessageRSSI Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for LastMessageRSSI attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/LastMessageRSSI/+'

# Example output

ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/LastMessageRSSI/Desired { "value": <DESIRED_LAST_MESSAGERSSI>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/LastMessageRSSI/Reported { "value": <REPORTED_LAST_MESSAGERSSI>}

\subsection diagnostics_attr_cluster_revision Diagnostics/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/ClusterRevision/Reported
[PREFIX]/Diagnostics/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Diagnostics Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Diagnostics/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/Diagnostics/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/Diagnostics/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section diagnostics_recv_cmd_support Diagnostics Command Support

MQTT Topic Pattern:

[PREFIX]/Diagnostics/SupportedCommands
[PREFIX]/Diagnostics/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Diagnostics Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for Diagnostics cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Diagnostics/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/Diagnostics/SupportedCommands { "value": [] }

To see supported generated commands for Diagnostics cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Diagnostics/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/Diagnostics/SupportedGeneratedCommands { "value": [] }

\section diagnostics_cmds Diagnostics Commands

\subsection diagnostics_write_attr_cmd Diagnostics/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Diagnostics Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all Diagnostics attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Diagnostics/Commands/WriteAttributes' -m  '{  }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection diagnostics_force_read_attr_cmd Diagnostics/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Diagnostics Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "NumberOfResets",
          "PersistentMemoryWrites",
          "MacRxBcast",
          "MacTxBcast",
          "MacRxUcast",
          "MacTxUcast",
          "MacTxUcastRetry",
          "MacTxUcastFail",
          "APSRxBcast",
          "APSTxBcast",
          "APSRxUcast",
          "APSTxUcastSuccess",
          "APSTxUcastRetry",
          "APSTxUcastFail",
          "RouteDiscInitiated",
          "NeighborAdded",
          "NeighborRemoved",
          "NeighborStale",
          "JoinIndication",
          "ChildMoved",
          "NWKFCFailure",
          "APSFCFailure",
          "APSUnauthorizedKey",
          "NWKDecryptFailures",
          "APSDecryptFailures",
          "PacketBufferAllocateFailures",
          "RelayedUcast",
          "PHYToMACQueueLimitReached",
          "PacketValidateDropCount",
          "AverageMACRetryPerAPSMessageSent",
          "LastMessageLQI",
          "LastMessageRSSI"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all Diagnostics attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Diagnostics/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the Diagnostics attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Diagnostics/Commands/ForceReadAttributes' -m  '{ "value": ["NumberOfResets"] }'

\page protocol_controller_rf_telemetry ProtocolController/RFTelemetry Cluster The following commands and attributes are accepted as JSON payloads for the ProtocolController-RFTelemetry cluster.

\section protocol_controller_rf_telemetry_attrs ProtocolController/RFTelemetry Attributes The following attribute topics are used to retrieve the ProtocolController-RFTelemetry cluster state.

\subsection protocol_controller_rf_telemetry_attr_tx_report_enabled ProtocolController-RFTelemetry/TxReportEnabled Attribute

MQTT Topic Pattern:

[PREFIX]/ProtocolController/RFTelemetry/Attributes/TxReportEnabled/Reported
[PREFIX]/ProtocolController/RFTelemetry/Attributes/TxReportEnabled/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ProtocolController/RFTelemetry Cluster TxReportEnabled Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "boolean"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for TxReportEnabled attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ProtocolController/RFTelemetry/Attributes/TxReportEnabled/+'

# Example output

ucl/by-unid/<UNID>/ProtocolController/RFTelemetry/Attributes/TxReportEnabled/Desired { "value": <DESIRED_TX_REPORT_ENABLED>}
ucl/by-unid/<UNID>/ProtocolController/RFTelemetry/Attributes/TxReportEnabled/Reported { "value": <REPORTED_TX_REPORT_ENABLED>}

\subsection protocol_controller_rf_telemetry_attr_pti_enabled ProtocolController-RFTelemetry/PTIEnabled Attribute

MQTT Topic Pattern:

[PREFIX]/ProtocolController/RFTelemetry/Attributes/PTIEnabled/Reported
[PREFIX]/ProtocolController/RFTelemetry/Attributes/PTIEnabled/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ProtocolController/RFTelemetry Cluster PTIEnabled Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "boolean"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for PTIEnabled attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ProtocolController/RFTelemetry/Attributes/PTIEnabled/+'

# Example output

ucl/by-unid/<UNID>/ProtocolController/RFTelemetry/Attributes/PTIEnabled/Desired { "value": <DESIRED_PTI_ENABLED>}
ucl/by-unid/<UNID>/ProtocolController/RFTelemetry/Attributes/PTIEnabled/Reported { "value": <REPORTED_PTI_ENABLED>}

\subsection protocol_controller_rf_telemetry_attr_cluster_revision ProtocolController/RFTelemetry/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/ProtocolController/RFTelemetry/Attributes/ClusterRevision/Reported
[PREFIX]/ProtocolController/RFTelemetry/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ProtocolController/RFTelemetry Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ProtocolController/RFTelemetry/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/ProtocolController/RFTelemetry/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/ProtocolController/RFTelemetry/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section protocol_controller_rf_telemetry_recv_cmd_support ProtocolController/RFTelemetry Command Support

MQTT Topic Pattern:

[PREFIX]/ProtocolController/RFTelemetry/SupportedCommands
[PREFIX]/ProtocolController/RFTelemetry/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ProtocolController/RFTelemetry Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
              "TxReport",
              "WriteAttributes",
              "ForceReadAttributes"
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for ProtocolController-RFTelemetry cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/ProtocolController/RFTelemetry/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/ProtocolController/RFTelemetry/SupportedCommands { "value": ["TxReport","WriteAttributes", "ForceReadAttributes"] }

To see supported generated commands for ProtocolController-RFTelemetry cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/ProtocolController/RFTelemetry/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/ProtocolController/RFTelemetry/SupportedGeneratedCommands { "value": [] }

\section protocol_controller_rf_telemetry_cmds ProtocolController/RFTelemetry Commands

\subsection protocol_controller_rf_telemetry_tx_report_cmd ProtocolController/RFTelemetry/TxReport Command

MQTT Topic Pattern:

[PREFIX]/ProtocolController/RFTelemetry/Commands/TxReport
[PREFIX]/ProtocolController/RFTelemetry/GeneratedCommands/TxReport

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ProtocolController/RFTelemetry Cluster TxReport Command Properties",
  "type": "object",
  "properties": {
    "SourceUNID": {
      "type": "string"
    },
    "DestinationUNID": {
      "type": "string"
    },
    "TransmissionSuccessful": {
      "type": "boolean"
    },
    "TransmissionTimeMs": {
      "type": "integer"
    },
    "TxPowerdBm": {
      "type": "integer"
    },
    "TxChannel": {
      "type": "integer"
    },
    "RoutingAttempts": {
      "type": "integer"
    },
    "RouteChanged": {
      "type": "boolean"
    },
    "TransmissionSpeed": {
      "type": "TxReportTransmissionSpeed"
    },
    "MeasuredNoiseFloordBm": {
      "type": "integer"
    },
    "LastRouteRepeaters": {
      "type": "array",
      "items": {
        "type": "string"
      }
,
    "IncomingRSSIRepeaters": {
      "type": "array",
      "items": {
        "type": "integer"
      }
,
    "AckRSSI": {
      "type": "integer"
    },
    "AckChannel": {
      "type": "integer"
    },
    "LastRouteFailedLinkFunctionalUNID": {
      "type": "string"
    },
    "LastRouteFailedLinkNonFunctionalUNID": {
      "type": "string"
    },
    "DestinationAckTxPowerdBm": {
      "type": "integer"
    },
    "DestinationAckMeasuredRSSI": {
      "type": "integer"
    },
    "DestinationAckMeasuredNoiseFloor": {
      "type": "integer"
    }
  },
  "required": [
    "SourceUNID",
    "DestinationUNID",
    "TransmissionSuccessful",
    "TransmissionTimeMs",
    "TxPowerdBm",
    "TxChannel",
    "RoutingAttempts",
    "RouteChanged",
    "TransmissionSpeed",
    "MeasuredNoiseFloordBm",
    "LastRouteRepeaters",
    "IncomingRSSIRepeaters",
    "AckRSSI",
    "AckChannel",
    "LastRouteFailedLinkFunctionalUNID",
    "LastRouteFailedLinkNonFunctionalUNID",
    "DestinationAckTxPowerdBm",
    "DestinationAckMeasuredRSSI",
    "DestinationAckMeasuredNoiseFloor"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ProtocolController/RFTelemetry/TxReport command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/ProtocolController/RFTelemetry/Commands/TxReport' -m  '{ "SourceUNID": <SOURCEUNID_VALUE>,"DestinationUNID": <DESTINATIONUNID_VALUE>,"TransmissionSuccessful": <TRANSMISSION_SUCCESSFUL_VALUE>,"TransmissionTimeMs": <TRANSMISSION_TIME_MS_VALUE>,"TxPowerdBm": <TX_POWERD_BM_VALUE>,"TxChannel": <TX_CHANNEL_VALUE>,"RoutingAttempts": <ROUTING_ATTEMPTS_VALUE>,"RouteChanged": <ROUTE_CHANGED_VALUE>,"TransmissionSpeed": <TRANSMISSION_SPEED_VALUE>,"MeasuredNoiseFloordBm": <MEASURED_NOISE_FLOORD_BM_VALUE>,"LastRouteRepeaters": <LAST_ROUTE_REPEATERS_VALUE>,"IncomingRSSIRepeaters": <INCOMING_RSSI_REPEATERS_VALUE>,"AckRSSI": <ACKRSSI_VALUE>,"AckChannel": <ACK_CHANNEL_VALUE>,"LastRouteFailedLinkFunctionalUNID": <LAST_ROUTE_FAILED_LINK_FUNCTIONALUNID_VALUE>,"LastRouteFailedLinkNonFunctionalUNID": <LAST_ROUTE_FAILED_LINK_NON_FUNCTIONALUNID_VALUE>,"DestinationAckTxPowerdBm": <DESTINATION_ACK_TX_POWERD_BM_VALUE>,"DestinationAckMeasuredRSSI": <DESTINATION_ACK_MEASUREDRSSI_VALUE>,"DestinationAckMeasuredNoiseFloor": <DESTINATION_ACK_MEASURED_NOISE_FLOOR_VALUE> }'

To receive a ProtocolController/RFTelemetry/TxReport generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/ProtocolController/RFTelemetry/GeneratedCommands/TxReport'

\subsection protocol_controller_rf_telemetry_write_attr_cmd ProtocolController/RFTelemetry/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/ProtocolController/RFTelemetry/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ProtocolController/RFTelemetry Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
    "TxReportEnabled": {
      "type": "boolean"
    },
    "PTIEnabled": {
      "type": "boolean"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all ProtocolController/RFTelemetry attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ProtocolController/RFTelemetry/Commands/WriteAttributes' -m  '{ "TxReportEnabled": <TX_REPORT_ENABLED_VALUE> ,"PTIEnabled": <PTI_ENABLED_VALUE>  }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection protocol_controller_rf_telemetry_force_read_attr_cmd ProtocolController/RFTelemetry/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/ProtocolController/RFTelemetry/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ProtocolController/RFTelemetry Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "TxReportEnabled",
          "PTIEnabled"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all ProtocolController/RFTelemetry attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ProtocolController/RFTelemetry/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the ProtocolController/RFTelemetry attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ProtocolController/RFTelemetry/Commands/ForceReadAttributes' -m  '{ "value": ["TxReportEnabled"] }'

\page state State Cluster The following commands and attributes are accepted as JSON payloads for the State cluster.

\section state_attrs State Attributes The following attribute topics are used to retrieve the State cluster state.

\subsection state_attr_endpoint_id_list State/EndpointIdList Attribute

MQTT Topic Pattern:

[PREFIX]/State/Attributes/EndpointIdList/Reported
[PREFIX]/State/Attributes/EndpointIdList/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "State Cluster EndpointIdList Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "type": "integer"
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for EndpointIdList attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/State/Attributes/EndpointIdList/+'

# Example output

ucl/by-unid/<UNID>/State/Attributes/EndpointIdList/Desired { "value": [<DESIRED_ENDPOINT_ID_LIST>,<DESIRED_ENDPOINT_ID_LIST>]}
ucl/by-unid/<UNID>/State/Attributes/EndpointIdList/Reported { "value": [<REPORTED_ENDPOINT_ID_LIST>,<REPORTED_ENDPOINT_ID_LIST>]}

\subsection state_attr_network_status State/NetworkStatus Attribute

MQTT Topic Pattern:

[PREFIX]/State/Attributes/NetworkStatus/Reported
[PREFIX]/State/Attributes/NetworkStatus/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "State Cluster NetworkStatus Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "NodeStateNetworkStatus"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for NetworkStatus attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/State/Attributes/NetworkStatus/+'

# Example output

ucl/by-unid/<UNID>/State/Attributes/NetworkStatus/Desired { "value": <DESIRED_NETWORK_STATUS>}
ucl/by-unid/<UNID>/State/Attributes/NetworkStatus/Reported { "value": <REPORTED_NETWORK_STATUS>}

\subsection state_attr_security State/Security Attribute

MQTT Topic Pattern:

[PREFIX]/State/Attributes/Security/Reported
[PREFIX]/State/Attributes/Security/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "State Cluster Security Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "NodeStateSecurity"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Security attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/State/Attributes/Security/+'

# Example output

ucl/by-unid/<UNID>/State/Attributes/Security/Desired { "value": <DESIRED_SECURITY>}
ucl/by-unid/<UNID>/State/Attributes/Security/Reported { "value": <REPORTED_SECURITY>}

\subsection state_attr_maximum_command_delay State/MaximumCommandDelay Attribute

MQTT Topic Pattern:

[PREFIX]/State/Attributes/MaximumCommandDelay/Reported
[PREFIX]/State/Attributes/MaximumCommandDelay/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "State Cluster MaximumCommandDelay Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MaximumCommandDelay attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/State/Attributes/MaximumCommandDelay/+'

# Example output

ucl/by-unid/<UNID>/State/Attributes/MaximumCommandDelay/Desired { "value": <DESIRED_MAXIMUM_COMMAND_DELAY>}
ucl/by-unid/<UNID>/State/Attributes/MaximumCommandDelay/Reported { "value": <REPORTED_MAXIMUM_COMMAND_DELAY>}

\subsection state_attr_network_list State/NetworkList Attribute

MQTT Topic Pattern:

[PREFIX]/State/Attributes/NetworkList/Reported
[PREFIX]/State/Attributes/NetworkList/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "State Cluster NetworkList Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for NetworkList attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/State/Attributes/NetworkList/+'

# Example output

ucl/by-unid/<UNID>/State/Attributes/NetworkList/Desired { "value": [<DESIRED_NETWORK_LIST>,<DESIRED_NETWORK_LIST>]}
ucl/by-unid/<UNID>/State/Attributes/NetworkList/Reported { "value": [<REPORTED_NETWORK_LIST>,<REPORTED_NETWORK_LIST>]}

\subsection state_attr_cluster_revision State/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/State/Attributes/ClusterRevision/Reported
[PREFIX]/State/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "State Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/State/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/State/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/State/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section state_recv_cmd_support State Command Support

MQTT Topic Pattern:

[PREFIX]/State/SupportedCommands
[PREFIX]/State/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "State Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
              "Remove",
              "RemoveOffline",
              "DiscoverNeighbors",
              "Interview",
              "DiscoverSecurity",
              "WriteAttributes",
              "ForceReadAttributes"
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for State cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/State/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/State/SupportedCommands { "value": ["Remove","RemoveOffline","DiscoverNeighbors","Interview","DiscoverSecurity","WriteAttributes", "ForceReadAttributes"] }

To see supported generated commands for State cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/State/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/State/SupportedGeneratedCommands { "value": [] }

\section state_cmds State Commands

\subsection state_remove_cmd State/Remove Command

MQTT Topic Pattern:

[PREFIX]/State/Commands/Remove
[PREFIX]/State/GeneratedCommands/Remove

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "State Cluster Remove Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
  ]
}

Example Mosquitto CLI Tool Usage

To send a State/Remove command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/State/Commands/Remove' -m  '{  }'

To receive a State/Remove generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/State/GeneratedCommands/Remove'

\subsection state_remove_offline_cmd State/RemoveOffline Command

MQTT Topic Pattern:

[PREFIX]/State/Commands/RemoveOffline
[PREFIX]/State/GeneratedCommands/RemoveOffline

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "State Cluster RemoveOffline Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
  ]
}

Example Mosquitto CLI Tool Usage

To send a State/RemoveOffline command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/State/Commands/RemoveOffline' -m  '{  }'

To receive a State/RemoveOffline generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/State/GeneratedCommands/RemoveOffline'

\subsection state_discover_neighbors_cmd State/DiscoverNeighbors Command

MQTT Topic Pattern:

[PREFIX]/State/Commands/DiscoverNeighbors
[PREFIX]/State/GeneratedCommands/DiscoverNeighbors

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "State Cluster DiscoverNeighbors Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
  ]
}

Example Mosquitto CLI Tool Usage

To send a State/DiscoverNeighbors command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/State/Commands/DiscoverNeighbors' -m  '{  }'

To receive a State/DiscoverNeighbors generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/State/GeneratedCommands/DiscoverNeighbors'

\subsection state_interview_cmd State/Interview Command

MQTT Topic Pattern:

[PREFIX]/State/Commands/Interview
[PREFIX]/State/GeneratedCommands/Interview

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "State Cluster Interview Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
  ]
}

Example Mosquitto CLI Tool Usage

To send a State/Interview command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/State/Commands/Interview' -m  '{  }'

To receive a State/Interview generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/State/GeneratedCommands/Interview'

\subsection state_discover_security_cmd State/DiscoverSecurity Command

MQTT Topic Pattern:

[PREFIX]/State/Commands/DiscoverSecurity
[PREFIX]/State/GeneratedCommands/DiscoverSecurity

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "State Cluster DiscoverSecurity Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
  ]
}

Example Mosquitto CLI Tool Usage

To send a State/DiscoverSecurity command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/State/Commands/DiscoverSecurity' -m  '{  }'

To receive a State/DiscoverSecurity generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/State/GeneratedCommands/DiscoverSecurity'

\subsection state_write_attr_cmd State/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/State/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "State Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all State attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/State/Commands/WriteAttributes' -m  '{  }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection state_force_read_attr_cmd State/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/State/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "State Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "EndpointIdList",
          "NetworkStatus",
          "Security",
          "MaximumCommandDelay",
          "NetworkList"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all State attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/State/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the State attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/State/Commands/ForceReadAttributes' -m  '{ "value": ["EndpointIdList"] }'

\page binding Binding Cluster The following commands and attributes are accepted as JSON payloads for the Binding cluster.

\section binding_attrs Binding Attributes The following attribute topics are used to retrieve the Binding cluster state.

\subsection binding_attr_binding_table_full Binding/BindingTableFull Attribute

MQTT Topic Pattern:

[PREFIX]/Binding/Attributes/BindingTableFull/Reported
[PREFIX]/Binding/Attributes/BindingTableFull/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Binding Cluster BindingTableFull Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "boolean"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for BindingTableFull attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Binding/Attributes/BindingTableFull/+'

# Example output

ucl/by-unid/<UNID>/ep0/Binding/Attributes/BindingTableFull/Desired { "value": <DESIRED_BINDING_TABLE_FULL>}
ucl/by-unid/<UNID>/ep0/Binding/Attributes/BindingTableFull/Reported { "value": <REPORTED_BINDING_TABLE_FULL>}

\subsection binding_attr_bindable_cluster_list Binding/BindableClusterList Attribute

MQTT Topic Pattern:

[PREFIX]/Binding/Attributes/BindableClusterList/Reported
[PREFIX]/Binding/Attributes/BindableClusterList/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Binding Cluster BindableClusterList Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for BindableClusterList attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Binding/Attributes/BindableClusterList/+'

# Example output

ucl/by-unid/<UNID>/ep0/Binding/Attributes/BindableClusterList/Desired { "value": [<DESIRED_BINDABLE_CLUSTER_LIST>,<DESIRED_BINDABLE_CLUSTER_LIST>]}
ucl/by-unid/<UNID>/ep0/Binding/Attributes/BindableClusterList/Reported { "value": [<REPORTED_BINDABLE_CLUSTER_LIST>,<REPORTED_BINDABLE_CLUSTER_LIST>]}

\subsection binding_attr_binding_table Binding/BindingTable Attribute

MQTT Topic Pattern:

[PREFIX]/Binding/Attributes/BindingTable/Reported
[PREFIX]/Binding/Attributes/BindingTable/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Binding Cluster BindingTable Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "type": "BindingObject"
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for BindingTable attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Binding/Attributes/BindingTable/+'

# Example output

ucl/by-unid/<UNID>/ep0/Binding/Attributes/BindingTable/Desired { "value": [<DESIRED_BINDING_TABLE>,<DESIRED_BINDING_TABLE>]}
ucl/by-unid/<UNID>/ep0/Binding/Attributes/BindingTable/Reported { "value": [<REPORTED_BINDING_TABLE>,<REPORTED_BINDING_TABLE>]}

\subsection binding_attr_cluster_revision Binding/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/Binding/Attributes/ClusterRevision/Reported
[PREFIX]/Binding/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Binding Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Binding/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/Binding/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/Binding/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section binding_recv_cmd_support Binding Command Support

MQTT Topic Pattern:

[PREFIX]/Binding/SupportedCommands
[PREFIX]/Binding/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Binding Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
              "Bind",
              "Unbind",
              "BindToProtocolController",
              "UnbindFromProtocolController",
              "WriteAttributes",
              "ForceReadAttributes"
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for Binding cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Binding/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/Binding/SupportedCommands { "value": ["Bind","Unbind","BindToProtocolController","UnbindFromProtocolController","WriteAttributes", "ForceReadAttributes"] }

To see supported generated commands for Binding cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Binding/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/Binding/SupportedGeneratedCommands { "value": [] }

\section binding_cmds Binding Commands

\subsection binding_bind_cmd Binding/Bind Command

MQTT Topic Pattern:

[PREFIX]/Binding/Commands/Bind
[PREFIX]/Binding/GeneratedCommands/Bind

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Binding Cluster Bind Command Properties",
  "type": "object",
  "properties": {
    "ClusterName": {
      "type": "string"
    },
    "DestinationUnid": {
      "type": "string"
    },
    "DestinationEp": {
      "type": "integer"
    }
  },
  "required": [
    "ClusterName",
    "DestinationUnid",
    "DestinationEp"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Binding/Bind command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Binding/Commands/Bind' -m  '{ "ClusterName": <CLUSTER_NAME_VALUE>,"DestinationUnid": <DESTINATION_UNID_VALUE>,"DestinationEp": <DESTINATION_EP_VALUE> }'

To receive a Binding/Bind generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Binding/GeneratedCommands/Bind'

\subsection binding_unbind_cmd Binding/Unbind Command

MQTT Topic Pattern:

[PREFIX]/Binding/Commands/Unbind
[PREFIX]/Binding/GeneratedCommands/Unbind

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Binding Cluster Unbind Command Properties",
  "type": "object",
  "properties": {
    "ClusterName": {
      "type": "string"
    },
    "DestinationUnid": {
      "type": "string"
    },
    "DestinationEp": {
      "type": "integer"
    }
  },
  "required": [
    "ClusterName",
    "DestinationUnid",
    "DestinationEp"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Binding/Unbind command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Binding/Commands/Unbind' -m  '{ "ClusterName": <CLUSTER_NAME_VALUE>,"DestinationUnid": <DESTINATION_UNID_VALUE>,"DestinationEp": <DESTINATION_EP_VALUE> }'

To receive a Binding/Unbind generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Binding/GeneratedCommands/Unbind'

\subsection binding_bind_to_protocol_controller_cmd Binding/BindToProtocolController Command

MQTT Topic Pattern:

[PREFIX]/Binding/Commands/BindToProtocolController
[PREFIX]/Binding/GeneratedCommands/BindToProtocolController

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Binding Cluster BindToProtocolController Command Properties",
  "type": "object",
  "properties": {
    "ClusterName": {
      "type": "string"
    }
  },
  "required": [
    "ClusterName"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Binding/BindToProtocolController command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Binding/Commands/BindToProtocolController' -m  '{ "ClusterName": <CLUSTER_NAME_VALUE> }'

To receive a Binding/BindToProtocolController generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Binding/GeneratedCommands/BindToProtocolController'

\subsection binding_unbind_from_protocol_controller_cmd Binding/UnbindFromProtocolController Command

MQTT Topic Pattern:

[PREFIX]/Binding/Commands/UnbindFromProtocolController
[PREFIX]/Binding/GeneratedCommands/UnbindFromProtocolController

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Binding Cluster UnbindFromProtocolController Command Properties",
  "type": "object",
  "properties": {
    "ClusterName": {
      "type": "string"
    }
  },
  "required": [
    "ClusterName"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Binding/UnbindFromProtocolController command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Binding/Commands/UnbindFromProtocolController' -m  '{ "ClusterName": <CLUSTER_NAME_VALUE> }'

To receive a Binding/UnbindFromProtocolController generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Binding/GeneratedCommands/UnbindFromProtocolController'

\subsection binding_write_attr_cmd Binding/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/Binding/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Binding Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all Binding attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Binding/Commands/WriteAttributes' -m  '{  }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection binding_force_read_attr_cmd Binding/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/Binding/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Binding Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "BindingTableFull",
          "BindableClusterList",
          "BindingTable"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all Binding attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Binding/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the Binding attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Binding/Commands/ForceReadAttributes' -m  '{ "value": ["BindingTableFull"] }'

\page system_metrics SystemMetrics Cluster The following commands and attributes are accepted as JSON payloads for the SystemMetrics cluster.

\section system_metrics_attrs SystemMetrics Attributes The following attribute topics are used to retrieve the SystemMetrics cluster state.

\subsection system_metrics_attr_reporting_interval_seconds SystemMetrics/ReportingIntervalSeconds Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/ReportingIntervalSeconds/Reported
[PREFIX]/SystemMetrics/Attributes/ReportingIntervalSeconds/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster ReportingIntervalSeconds Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ReportingIntervalSeconds attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/ReportingIntervalSeconds/+'

# Example output

ucl/by-unid/<UNID>/SystemMetrics/Attributes/ReportingIntervalSeconds/Desired { "value": <DESIRED_REPORTING_INTERVAL_SECONDS>}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/ReportingIntervalSeconds/Reported { "value": <REPORTED_REPORTING_INTERVAL_SECONDS>}

\subsection system_metrics_attr_cpu_usage_percent SystemMetrics/CPUUsagePercent Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/CPUUsagePercent/Reported
[PREFIX]/SystemMetrics/Attributes/CPUUsagePercent/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster CPUUsagePercent Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "type": "number"
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CPUUsagePercent attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/CPUUsagePercent/+'

# Example output

ucl/by-unid/<UNID>/SystemMetrics/Attributes/CPUUsagePercent/Desired { "value": [<DESIRED_CPU_USAGE_PERCENT>,<DESIRED_CPU_USAGE_PERCENT>]}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/CPUUsagePercent/Reported { "value": [<REPORTED_CPU_USAGE_PERCENT>,<REPORTED_CPU_USAGE_PERCENT>]}

\subsection system_metrics_attr_cpu_frequencym_hz SystemMetrics/CPUFrequencyMHz Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/CPUFrequencyMHz/Reported
[PREFIX]/SystemMetrics/Attributes/CPUFrequencyMHz/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster CPUFrequencyMHz Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "type": "number"
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CPUFrequencyMHz attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/CPUFrequencyMHz/+'

# Example output

ucl/by-unid/<UNID>/SystemMetrics/Attributes/CPUFrequencyMHz/Desired { "value": [<DESIRED_CPU_FREQUENCYM_HZ>,<DESIRED_CPU_FREQUENCYM_HZ>]}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/CPUFrequencyMHz/Reported { "value": [<REPORTED_CPU_FREQUENCYM_HZ>,<REPORTED_CPU_FREQUENCYM_HZ>]}

\subsection system_metrics_attr_cpu_average_usage_percent SystemMetrics/CPUAverageUsagePercent Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/CPUAverageUsagePercent/Reported
[PREFIX]/SystemMetrics/Attributes/CPUAverageUsagePercent/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster CPUAverageUsagePercent Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "type": "number"
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CPUAverageUsagePercent attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/CPUAverageUsagePercent/+'

# Example output

ucl/by-unid/<UNID>/SystemMetrics/Attributes/CPUAverageUsagePercent/Desired { "value": [<DESIRED_CPU_AVERAGE_USAGE_PERCENT>,<DESIRED_CPU_AVERAGE_USAGE_PERCENT>]}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/CPUAverageUsagePercent/Reported { "value": [<REPORTED_CPU_AVERAGE_USAGE_PERCENT>,<REPORTED_CPU_AVERAGE_USAGE_PERCENT>]}

\subsection system_metrics_attr_cpu_min_usage_percent SystemMetrics/CPUMinUsagePercent Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/CPUMinUsagePercent/Reported
[PREFIX]/SystemMetrics/Attributes/CPUMinUsagePercent/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster CPUMinUsagePercent Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "type": "number"
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CPUMinUsagePercent attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/CPUMinUsagePercent/+'

# Example output

ucl/by-unid/<UNID>/SystemMetrics/Attributes/CPUMinUsagePercent/Desired { "value": [<DESIRED_CPU_MIN_USAGE_PERCENT>,<DESIRED_CPU_MIN_USAGE_PERCENT>]}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/CPUMinUsagePercent/Reported { "value": [<REPORTED_CPU_MIN_USAGE_PERCENT>,<REPORTED_CPU_MIN_USAGE_PERCENT>]}

\subsection system_metrics_attr_cpu_max_usage_percent SystemMetrics/CPUMaxUsagePercent Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/CPUMaxUsagePercent/Reported
[PREFIX]/SystemMetrics/Attributes/CPUMaxUsagePercent/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster CPUMaxUsagePercent Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "type": "number"
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CPUMaxUsagePercent attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/CPUMaxUsagePercent/+'

# Example output

ucl/by-unid/<UNID>/SystemMetrics/Attributes/CPUMaxUsagePercent/Desired { "value": [<DESIRED_CPU_MAX_USAGE_PERCENT>,<DESIRED_CPU_MAX_USAGE_PERCENT>]}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/CPUMaxUsagePercent/Reported { "value": [<REPORTED_CPU_MAX_USAGE_PERCENT>,<REPORTED_CPU_MAX_USAGE_PERCENT>]}

\subsection system_metrics_attr_ram_totalmb SystemMetrics/RAMTotalMB Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/RAMTotalMB/Reported
[PREFIX]/SystemMetrics/Attributes/RAMTotalMB/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster RAMTotalMB Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RAMTotalMB attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/RAMTotalMB/+'

# Example output

ucl/by-unid/<UNID>/SystemMetrics/Attributes/RAMTotalMB/Desired { "value": <DESIRED_RAM_TOTALMB>}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/RAMTotalMB/Reported { "value": <REPORTED_RAM_TOTALMB>}

\subsection system_metrics_attr_ram_freemb SystemMetrics/RAMFreeMB Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/RAMFreeMB/Reported
[PREFIX]/SystemMetrics/Attributes/RAMFreeMB/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster RAMFreeMB Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RAMFreeMB attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/RAMFreeMB/+'

# Example output

ucl/by-unid/<UNID>/SystemMetrics/Attributes/RAMFreeMB/Desired { "value": <DESIRED_RAM_FREEMB>}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/RAMFreeMB/Reported { "value": <REPORTED_RAM_FREEMB>}

\subsection system_metrics_attr_ram_availablemb SystemMetrics/RAMAvailableMB Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/RAMAvailableMB/Reported
[PREFIX]/SystemMetrics/Attributes/RAMAvailableMB/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster RAMAvailableMB Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RAMAvailableMB attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/RAMAvailableMB/+'

# Example output

ucl/by-unid/<UNID>/SystemMetrics/Attributes/RAMAvailableMB/Desired { "value": <DESIRED_RAM_AVAILABLEMB>}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/RAMAvailableMB/Reported { "value": <REPORTED_RAM_AVAILABLEMB>}

\subsection system_metrics_attr_swap_memory_totalmb SystemMetrics/SWAPMemoryTotalMB Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/SWAPMemoryTotalMB/Reported
[PREFIX]/SystemMetrics/Attributes/SWAPMemoryTotalMB/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster SWAPMemoryTotalMB Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for SWAPMemoryTotalMB attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/SWAPMemoryTotalMB/+'

# Example output

ucl/by-unid/<UNID>/SystemMetrics/Attributes/SWAPMemoryTotalMB/Desired { "value": <DESIRED_SWAP_MEMORY_TOTALMB>}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/SWAPMemoryTotalMB/Reported { "value": <REPORTED_SWAP_MEMORY_TOTALMB>}

\subsection system_metrics_attr_swap_memory_usedmb SystemMetrics/SWAPMemoryUsedMB Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/SWAPMemoryUsedMB/Reported
[PREFIX]/SystemMetrics/Attributes/SWAPMemoryUsedMB/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster SWAPMemoryUsedMB Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for SWAPMemoryUsedMB attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/SWAPMemoryUsedMB/+'

# Example output

ucl/by-unid/<UNID>/SystemMetrics/Attributes/SWAPMemoryUsedMB/Desired { "value": <DESIRED_SWAP_MEMORY_USEDMB>}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/SWAPMemoryUsedMB/Reported { "value": <REPORTED_SWAP_MEMORY_USEDMB>}

\subsection system_metrics_attr_virtual_memory_totalmb SystemMetrics/VirtualMemoryTotalMB Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/VirtualMemoryTotalMB/Reported
[PREFIX]/SystemMetrics/Attributes/VirtualMemoryTotalMB/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster VirtualMemoryTotalMB Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for VirtualMemoryTotalMB attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/VirtualMemoryTotalMB/+'

# Example output

ucl/by-unid/<UNID>/SystemMetrics/Attributes/VirtualMemoryTotalMB/Desired { "value": <DESIRED_VIRTUAL_MEMORY_TOTALMB>}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/VirtualMemoryTotalMB/Reported { "value": <REPORTED_VIRTUAL_MEMORY_TOTALMB>}

\subsection system_metrics_attr_virtual_memory_usedmb SystemMetrics/VirtualMemoryUsedMB Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/VirtualMemoryUsedMB/Reported
[PREFIX]/SystemMetrics/Attributes/VirtualMemoryUsedMB/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster VirtualMemoryUsedMB Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for VirtualMemoryUsedMB attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/VirtualMemoryUsedMB/+'

# Example output

ucl/by-unid/<UNID>/SystemMetrics/Attributes/VirtualMemoryUsedMB/Desired { "value": <DESIRED_VIRTUAL_MEMORY_USEDMB>}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/VirtualMemoryUsedMB/Reported { "value": <REPORTED_VIRTUAL_MEMORY_USEDMB>}

\subsection system_metrics_attr_disks_usage SystemMetrics/DisksUsage Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/DisksUsage/Reported
[PREFIX]/SystemMetrics/Attributes/DisksUsage/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster DisksUsage Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "type": "DiskUsageData"
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DisksUsage attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/DisksUsage/+'

# Example output

ucl/by-unid/<UNID>/SystemMetrics/Attributes/DisksUsage/Desired { "value": [<DESIRED_DISKS_USAGE>,<DESIRED_DISKS_USAGE>]}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/DisksUsage/Reported { "value": [<REPORTED_DISKS_USAGE>,<REPORTED_DISKS_USAGE>]}

\subsection system_metrics_attr_disks_counters SystemMetrics/DisksCounters Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/DisksCounters/Reported
[PREFIX]/SystemMetrics/Attributes/DisksCounters/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster DisksCounters Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "type": "DiskIOCounters"
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DisksCounters attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/DisksCounters/+'

# Example output

ucl/by-unid/<UNID>/SystemMetrics/Attributes/DisksCounters/Desired { "value": [<DESIRED_DISKS_COUNTERS>,<DESIRED_DISKS_COUNTERS>]}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/DisksCounters/Reported { "value": [<REPORTED_DISKS_COUNTERS>,<REPORTED_DISKS_COUNTERS>]}

\subsection system_metrics_attr_network_interfaces_data SystemMetrics/NetworkInterfacesData Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/NetworkInterfacesData/Reported
[PREFIX]/SystemMetrics/Attributes/NetworkInterfacesData/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster NetworkInterfacesData Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "type": "NetworkInterfaceData"
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for NetworkInterfacesData attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/NetworkInterfacesData/+'

# Example output

ucl/by-unid/<UNID>/SystemMetrics/Attributes/NetworkInterfacesData/Desired { "value": [<DESIRED_NETWORK_INTERFACES_DATA>,<DESIRED_NETWORK_INTERFACES_DATA>]}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/NetworkInterfacesData/Reported { "value": [<REPORTED_NETWORK_INTERFACES_DATA>,<REPORTED_NETWORK_INTERFACES_DATA>]}

\subsection system_metrics_attr_wireless_network_interfaces_data SystemMetrics/WirelessNetworkInterfacesData Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/WirelessNetworkInterfacesData/Reported
[PREFIX]/SystemMetrics/Attributes/WirelessNetworkInterfacesData/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster WirelessNetworkInterfacesData Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "type": "WirelessNetworkInterfaceData"
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for WirelessNetworkInterfacesData attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/WirelessNetworkInterfacesData/+'

# Example output

ucl/by-unid/<UNID>/SystemMetrics/Attributes/WirelessNetworkInterfacesData/Desired { "value": [<DESIRED_WIRELESS_NETWORK_INTERFACES_DATA>,<DESIRED_WIRELESS_NETWORK_INTERFACES_DATA>]}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/WirelessNetworkInterfacesData/Reported { "value": [<REPORTED_WIRELESS_NETWORK_INTERFACES_DATA>,<REPORTED_WIRELESS_NETWORK_INTERFACES_DATA>]}

\subsection system_metrics_attr_hostname SystemMetrics/Hostname Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/Hostname/Reported
[PREFIX]/SystemMetrics/Attributes/Hostname/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster Hostname Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Hostname attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/Hostname/+'

# Example output

ucl/by-unid/<UNID>/SystemMetrics/Attributes/Hostname/Desired { "value": <DESIRED_HOSTNAME>}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/Hostname/Reported { "value": <REPORTED_HOSTNAME>}

\subsection system_metrics_attr_fqdn SystemMetrics/FQDN Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/FQDN/Reported
[PREFIX]/SystemMetrics/Attributes/FQDN/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster FQDN Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for FQDN attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/FQDN/+'

# Example output

ucl/by-unid/<UNID>/SystemMetrics/Attributes/FQDN/Desired { "value": <DESIRED_FQDN>}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/FQDN/Reported { "value": <REPORTED_FQDN>}

\subsection system_metrics_attr_uptime_minutes SystemMetrics/UptimeMinutes Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/UptimeMinutes/Reported
[PREFIX]/SystemMetrics/Attributes/UptimeMinutes/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster UptimeMinutes Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for UptimeMinutes attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/UptimeMinutes/+'

# Example output

ucl/by-unid/<UNID>/SystemMetrics/Attributes/UptimeMinutes/Desired { "value": <DESIRED_UPTIME_MINUTES>}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/UptimeMinutes/Reported { "value": <REPORTED_UPTIME_MINUTES>}

\subsection system_metrics_attr_current_temperature_celcius SystemMetrics/CurrentTemperatureCelcius Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/CurrentTemperatureCelcius/Reported
[PREFIX]/SystemMetrics/Attributes/CurrentTemperatureCelcius/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster CurrentTemperatureCelcius Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CurrentTemperatureCelcius attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/CurrentTemperatureCelcius/+'

# Example output

ucl/by-unid/<UNID>/SystemMetrics/Attributes/CurrentTemperatureCelcius/Desired { "value": <DESIRED_CURRENT_TEMPERATURE_CELCIUS>}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/CurrentTemperatureCelcius/Reported { "value": <REPORTED_CURRENT_TEMPERATURE_CELCIUS>}

\subsection system_metrics_attr_average_temperature_celcius SystemMetrics/AverageTemperatureCelcius Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/AverageTemperatureCelcius/Reported
[PREFIX]/SystemMetrics/Attributes/AverageTemperatureCelcius/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster AverageTemperatureCelcius Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for AverageTemperatureCelcius attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/AverageTemperatureCelcius/+'

# Example output

ucl/by-unid/<UNID>/SystemMetrics/Attributes/AverageTemperatureCelcius/Desired { "value": <DESIRED_AVERAGE_TEMPERATURE_CELCIUS>}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/AverageTemperatureCelcius/Reported { "value": <REPORTED_AVERAGE_TEMPERATURE_CELCIUS>}

\subsection system_metrics_attr_min_temperature_celcius SystemMetrics/MinTemperatureCelcius Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/MinTemperatureCelcius/Reported
[PREFIX]/SystemMetrics/Attributes/MinTemperatureCelcius/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster MinTemperatureCelcius Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MinTemperatureCelcius attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/MinTemperatureCelcius/+'

# Example output

ucl/by-unid/<UNID>/SystemMetrics/Attributes/MinTemperatureCelcius/Desired { "value": <DESIRED_MIN_TEMPERATURE_CELCIUS>}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/MinTemperatureCelcius/Reported { "value": <REPORTED_MIN_TEMPERATURE_CELCIUS>}

\subsection system_metrics_attr_max_temperature_celcius SystemMetrics/MaxTemperatureCelcius Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/MaxTemperatureCelcius/Reported
[PREFIX]/SystemMetrics/Attributes/MaxTemperatureCelcius/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster MaxTemperatureCelcius Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MaxTemperatureCelcius attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/MaxTemperatureCelcius/+'

# Example output

ucl/by-unid/<UNID>/SystemMetrics/Attributes/MaxTemperatureCelcius/Desired { "value": <DESIRED_MAX_TEMPERATURE_CELCIUS>}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/MaxTemperatureCelcius/Reported { "value": <REPORTED_MAX_TEMPERATURE_CELCIUS>}

\subsection system_metrics_attr_power_plugged SystemMetrics/PowerPlugged Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/PowerPlugged/Reported
[PREFIX]/SystemMetrics/Attributes/PowerPlugged/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster PowerPlugged Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "boolean"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for PowerPlugged attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/PowerPlugged/+'

# Example output

ucl/by-unid/<UNID>/SystemMetrics/Attributes/PowerPlugged/Desired { "value": <DESIRED_POWER_PLUGGED>}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/PowerPlugged/Reported { "value": <REPORTED_POWER_PLUGGED>}

\subsection system_metrics_attr_battery_percentage SystemMetrics/BatteryPercentage Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/BatteryPercentage/Reported
[PREFIX]/SystemMetrics/Attributes/BatteryPercentage/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster BatteryPercentage Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for BatteryPercentage attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/BatteryPercentage/+'

# Example output

ucl/by-unid/<UNID>/SystemMetrics/Attributes/BatteryPercentage/Desired { "value": <DESIRED_BATTERY_PERCENTAGE>}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/BatteryPercentage/Reported { "value": <REPORTED_BATTERY_PERCENTAGE>}

\subsection system_metrics_attr_system_interrupts SystemMetrics/SystemInterrupts Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/SystemInterrupts/Reported
[PREFIX]/SystemMetrics/Attributes/SystemInterrupts/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster SystemInterrupts Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for SystemInterrupts attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/SystemInterrupts/+'

# Example output

ucl/by-unid/<UNID>/SystemMetrics/Attributes/SystemInterrupts/Desired { "value": <DESIRED_SYSTEM_INTERRUPTS>}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/SystemInterrupts/Reported { "value": <REPORTED_SYSTEM_INTERRUPTS>}

\subsection system_metrics_attr_cluster_revision SystemMetrics/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/ClusterRevision/Reported
[PREFIX]/SystemMetrics/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/SystemMetrics/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/SystemMetrics/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/SystemMetrics/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section system_metrics_recv_cmd_support SystemMetrics Command Support

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/SupportedCommands
[PREFIX]/SystemMetrics/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for SystemMetrics cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/SystemMetrics/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/SystemMetrics/SupportedCommands { "value": [] }

To see supported generated commands for SystemMetrics cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/SystemMetrics/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/SystemMetrics/SupportedGeneratedCommands { "value": [] }

\section system_metrics_cmds SystemMetrics Commands

\subsection system_metrics_write_attr_cmd SystemMetrics/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
    "ReportingIntervalSeconds": {
      "type": "integer"
    },
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all SystemMetrics attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/SystemMetrics/Commands/WriteAttributes' -m  '{ "ReportingIntervalSeconds": <REPORTING_INTERVAL_SECONDS_VALUE> , }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection system_metrics_force_read_attr_cmd SystemMetrics/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "ReportingIntervalSeconds",
          "CPUUsagePercent",
          "CPUFrequencyMHz",
          "CPUAverageUsagePercent",
          "CPUMinUsagePercent",
          "CPUMaxUsagePercent",
          "RAMTotalMB",
          "RAMFreeMB",
          "RAMAvailableMB",
          "SWAPMemoryTotalMB",
          "SWAPMemoryUsedMB",
          "VirtualMemoryTotalMB",
          "VirtualMemoryUsedMB",
          "DisksUsage",
          "DisksCounters",
          "NetworkInterfacesData",
          "WirelessNetworkInterfacesData",
          "Hostname",
          "FQDN",
          "UptimeMinutes",
          "CurrentTemperatureCelcius",
          "AverageTemperatureCelcius",
          "MinTemperatureCelcius",
          "MaxTemperatureCelcius",
          "PowerPlugged",
          "BatteryPercentage",
          "SystemInterrupts"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all SystemMetrics attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/SystemMetrics/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the SystemMetrics attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/SystemMetrics/Commands/ForceReadAttributes' -m  '{ "value": ["ReportingIntervalSeconds"] }'

\page application_monitoring ApplicationMonitoring Cluster The following commands and attributes are accepted as JSON payloads for the ApplicationMonitoring cluster.

\section application_monitoring_attrs ApplicationMonitoring Attributes The following attribute topics are used to retrieve the ApplicationMonitoring cluster state.

\subsection application_monitoring_attr_application_name ApplicationMonitoring/ApplicationName Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/ApplicationName/Reported
[PREFIX]/ApplicationMonitoring/Attributes/ApplicationName/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster ApplicationName Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ApplicationName attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/ApplicationName/+'

# Example output

ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/ApplicationName/Desired { "value": <DESIRED_APPLICATION_NAME>}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/ApplicationName/Reported { "value": <REPORTED_APPLICATION_NAME>}

\subsection application_monitoring_attr_application_version ApplicationMonitoring/ApplicationVersion Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/ApplicationVersion/Reported
[PREFIX]/ApplicationMonitoring/Attributes/ApplicationVersion/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster ApplicationVersion Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ApplicationVersion attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/ApplicationVersion/+'

# Example output

ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/ApplicationVersion/Desired { "value": <DESIRED_APPLICATION_VERSION>}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/ApplicationVersion/Reported { "value": <REPORTED_APPLICATION_VERSION>}

\subsection application_monitoring_attr_application_connected ApplicationMonitoring/ApplicationConnected Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/ApplicationConnected/Reported
[PREFIX]/ApplicationMonitoring/Attributes/ApplicationConnected/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster ApplicationConnected Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "boolean"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ApplicationConnected attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/ApplicationConnected/+'

# Example output

ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/ApplicationConnected/Desired { "value": <DESIRED_APPLICATION_CONNECTED>}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/ApplicationConnected/Reported { "value": <REPORTED_APPLICATION_CONNECTED>}

\subsection application_monitoring_attr_application_mqtt_topics ApplicationMonitoring/ApplicationMQTTTopics Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/ApplicationMQTTTopics/Reported
[PREFIX]/ApplicationMonitoring/Attributes/ApplicationMQTTTopics/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster ApplicationMQTTTopics Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ApplicationMQTTTopics attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/ApplicationMQTTTopics/+'

# Example output

ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/ApplicationMQTTTopics/Desired { "value": [<DESIRED_APPLICATION_MQTT_TOPICS>,<DESIRED_APPLICATION_MQTT_TOPICS>]}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/ApplicationMQTTTopics/Reported { "value": [<REPORTED_APPLICATION_MQTT_TOPICS>,<REPORTED_APPLICATION_MQTT_TOPICS>]}

\subsection application_monitoring_attr_uptime_minutes ApplicationMonitoring/UptimeMinutes Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/UptimeMinutes/Reported
[PREFIX]/ApplicationMonitoring/Attributes/UptimeMinutes/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster UptimeMinutes Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for UptimeMinutes attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/UptimeMinutes/+'

# Example output

ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/UptimeMinutes/Desired { "value": <DESIRED_UPTIME_MINUTES>}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/UptimeMinutes/Reported { "value": <REPORTED_UPTIME_MINUTES>}

\subsection application_monitoring_attr_process_id ApplicationMonitoring/ProcessId Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/ProcessId/Reported
[PREFIX]/ApplicationMonitoring/Attributes/ProcessId/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster ProcessId Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ProcessId attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/ProcessId/+'

# Example output

ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/ProcessId/Desired { "value": <DESIRED_PROCESS_ID>}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/ProcessId/Reported { "value": <REPORTED_PROCESS_ID>}

\subsection application_monitoring_attr_hostname ApplicationMonitoring/Hostname Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/Hostname/Reported
[PREFIX]/ApplicationMonitoring/Attributes/Hostname/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster Hostname Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Hostname attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/Hostname/+'

# Example output

ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/Hostname/Desired { "value": <DESIRED_HOSTNAME>}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/Hostname/Reported { "value": <REPORTED_HOSTNAME>}

\subsection application_monitoring_attr_fqdn ApplicationMonitoring/FQDN Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/FQDN/Reported
[PREFIX]/ApplicationMonitoring/Attributes/FQDN/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster FQDN Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for FQDN attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/FQDN/+'

# Example output

ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/FQDN/Desired { "value": <DESIRED_FQDN>}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/FQDN/Reported { "value": <REPORTED_FQDN>}

\subsection application_monitoring_attr_mqtt_logging_enabled ApplicationMonitoring/MQTTLoggingEnabled Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/MQTTLoggingEnabled/Reported
[PREFIX]/ApplicationMonitoring/Attributes/MQTTLoggingEnabled/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster MQTTLoggingEnabled Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "boolean"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MQTTLoggingEnabled attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/MQTTLoggingEnabled/+'

# Example output

ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/MQTTLoggingEnabled/Desired { "value": <DESIRED_MQTT_LOGGING_ENABLED>}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/MQTTLoggingEnabled/Reported { "value": <REPORTED_MQTT_LOGGING_ENABLED>}

\subsection application_monitoring_attr_mqtt_logging_level ApplicationMonitoring/MQTTLoggingLevel Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/MQTTLoggingLevel/Reported
[PREFIX]/ApplicationMonitoring/Attributes/MQTTLoggingLevel/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster MQTTLoggingLevel Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "LoggingLevelEnum"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MQTTLoggingLevel attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/MQTTLoggingLevel/+'

# Example output

ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/MQTTLoggingLevel/Desired { "value": <DESIRED_MQTT_LOGGING_LEVEL>}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/MQTTLoggingLevel/Reported { "value": <REPORTED_MQTT_LOGGING_LEVEL>}

\subsection application_monitoring_attr_mqtt_statistics_reporting_interval_seconds ApplicationMonitoring/MQTTStatisticsReportingIntervalSeconds Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/MQTTStatisticsReportingIntervalSeconds/Reported
[PREFIX]/ApplicationMonitoring/Attributes/MQTTStatisticsReportingIntervalSeconds/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster MQTTStatisticsReportingIntervalSeconds Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MQTTStatisticsReportingIntervalSeconds attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/MQTTStatisticsReportingIntervalSeconds/+'

# Example output

ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/MQTTStatisticsReportingIntervalSeconds/Desired { "value": <DESIRED_MQTT_STATISTICS_REPORTING_INTERVAL_SECONDS>}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/MQTTStatisticsReportingIntervalSeconds/Reported { "value": <REPORTED_MQTT_STATISTICS_REPORTING_INTERVAL_SECONDS>}

\subsection application_monitoring_attr_mqtt_messages_sent ApplicationMonitoring/MQTTMessagesSent Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/MQTTMessagesSent/Reported
[PREFIX]/ApplicationMonitoring/Attributes/MQTTMessagesSent/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster MQTTMessagesSent Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MQTTMessagesSent attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/MQTTMessagesSent/+'

# Example output

ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/MQTTMessagesSent/Desired { "value": <DESIRED_MQTT_MESSAGES_SENT>}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/MQTTMessagesSent/Reported { "value": <REPORTED_MQTT_MESSAGES_SENT>}

\subsection application_monitoring_attr_mqtt_messages_received ApplicationMonitoring/MQTTMessagesReceived Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/MQTTMessagesReceived/Reported
[PREFIX]/ApplicationMonitoring/Attributes/MQTTMessagesReceived/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster MQTTMessagesReceived Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MQTTMessagesReceived attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/MQTTMessagesReceived/+'

# Example output

ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/MQTTMessagesReceived/Desired { "value": <DESIRED_MQTT_MESSAGES_RECEIVED>}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/MQTTMessagesReceived/Reported { "value": <REPORTED_MQTT_MESSAGES_RECEIVED>}

\subsection application_monitoring_attr_mqtt_subscription_count ApplicationMonitoring/MQTTSubscriptionCount Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/MQTTSubscriptionCount/Reported
[PREFIX]/ApplicationMonitoring/Attributes/MQTTSubscriptionCount/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster MQTTSubscriptionCount Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MQTTSubscriptionCount attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/MQTTSubscriptionCount/+'

# Example output

ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/MQTTSubscriptionCount/Desired { "value": <DESIRED_MQTT_SUBSCRIPTION_COUNT>}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/MQTTSubscriptionCount/Reported { "value": <REPORTED_MQTT_SUBSCRIPTION_COUNT>}

\subsection application_monitoring_attr_mqtt_average_delivery_time_seconds ApplicationMonitoring/MQTTAverageDeliveryTimeSeconds Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/MQTTAverageDeliveryTimeSeconds/Reported
[PREFIX]/ApplicationMonitoring/Attributes/MQTTAverageDeliveryTimeSeconds/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster MQTTAverageDeliveryTimeSeconds Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MQTTAverageDeliveryTimeSeconds attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/MQTTAverageDeliveryTimeSeconds/+'

# Example output

ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/MQTTAverageDeliveryTimeSeconds/Desired { "value": <DESIRED_MQTT_AVERAGE_DELIVERY_TIME_SECONDS>}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/MQTTAverageDeliveryTimeSeconds/Reported { "value": <REPORTED_MQTT_AVERAGE_DELIVERY_TIME_SECONDS>}

\subsection application_monitoring_attr_mqtt_min_delivery_time_seconds ApplicationMonitoring/MQTTMinDeliveryTimeSeconds Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/MQTTMinDeliveryTimeSeconds/Reported
[PREFIX]/ApplicationMonitoring/Attributes/MQTTMinDeliveryTimeSeconds/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster MQTTMinDeliveryTimeSeconds Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MQTTMinDeliveryTimeSeconds attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/MQTTMinDeliveryTimeSeconds/+'

# Example output

ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/MQTTMinDeliveryTimeSeconds/Desired { "value": <DESIRED_MQTT_MIN_DELIVERY_TIME_SECONDS>}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/MQTTMinDeliveryTimeSeconds/Reported { "value": <REPORTED_MQTT_MIN_DELIVERY_TIME_SECONDS>}

\subsection application_monitoring_attr_mqtt_max_delivery_time_seconds ApplicationMonitoring/MQTTMaxDeliveryTimeSeconds Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/MQTTMaxDeliveryTimeSeconds/Reported
[PREFIX]/ApplicationMonitoring/Attributes/MQTTMaxDeliveryTimeSeconds/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster MQTTMaxDeliveryTimeSeconds Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MQTTMaxDeliveryTimeSeconds attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/MQTTMaxDeliveryTimeSeconds/+'

# Example output

ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/MQTTMaxDeliveryTimeSeconds/Desired { "value": <DESIRED_MQTT_MAX_DELIVERY_TIME_SECONDS>}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/MQTTMaxDeliveryTimeSeconds/Reported { "value": <REPORTED_MQTT_MAX_DELIVERY_TIME_SECONDS>}

\subsection application_monitoring_attr_application_statistics_reporting_interval_seconds ApplicationMonitoring/ApplicationStatisticsReportingIntervalSeconds Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/ApplicationStatisticsReportingIntervalSeconds/Reported
[PREFIX]/ApplicationMonitoring/Attributes/ApplicationStatisticsReportingIntervalSeconds/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster ApplicationStatisticsReportingIntervalSeconds Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ApplicationStatisticsReportingIntervalSeconds attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/ApplicationStatisticsReportingIntervalSeconds/+'

# Example output

ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/ApplicationStatisticsReportingIntervalSeconds/Desired { "value": <DESIRED_APPLICATION_STATISTICS_REPORTING_INTERVAL_SECONDS>}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/ApplicationStatisticsReportingIntervalSeconds/Reported { "value": <REPORTED_APPLICATION_STATISTICS_REPORTING_INTERVAL_SECONDS>}

\subsection application_monitoring_attr_application_cpu_usage_percent ApplicationMonitoring/ApplicationCPUUsagePercent Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/ApplicationCPUUsagePercent/Reported
[PREFIX]/ApplicationMonitoring/Attributes/ApplicationCPUUsagePercent/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster ApplicationCPUUsagePercent Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ApplicationCPUUsagePercent attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/ApplicationCPUUsagePercent/+'

# Example output

ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/ApplicationCPUUsagePercent/Desired { "value": <DESIRED_APPLICATION_CPU_USAGE_PERCENT>}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/ApplicationCPUUsagePercent/Reported { "value": <REPORTED_APPLICATION_CPU_USAGE_PERCENT>}

\subsection application_monitoring_attr_application_cpu_average_usage_percent ApplicationMonitoring/ApplicationCPUAverageUsagePercent Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/ApplicationCPUAverageUsagePercent/Reported
[PREFIX]/ApplicationMonitoring/Attributes/ApplicationCPUAverageUsagePercent/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster ApplicationCPUAverageUsagePercent Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ApplicationCPUAverageUsagePercent attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/ApplicationCPUAverageUsagePercent/+'

# Example output

ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/ApplicationCPUAverageUsagePercent/Desired { "value": <DESIRED_APPLICATION_CPU_AVERAGE_USAGE_PERCENT>}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/ApplicationCPUAverageUsagePercent/Reported { "value": <REPORTED_APPLICATION_CPU_AVERAGE_USAGE_PERCENT>}

\subsection application_monitoring_attr_application_cpu_min_usage_percent ApplicationMonitoring/ApplicationCPUMinUsagePercent Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/ApplicationCPUMinUsagePercent/Reported
[PREFIX]/ApplicationMonitoring/Attributes/ApplicationCPUMinUsagePercent/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster ApplicationCPUMinUsagePercent Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ApplicationCPUMinUsagePercent attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/ApplicationCPUMinUsagePercent/+'

# Example output

ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/ApplicationCPUMinUsagePercent/Desired { "value": <DESIRED_APPLICATION_CPU_MIN_USAGE_PERCENT>}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/ApplicationCPUMinUsagePercent/Reported { "value": <REPORTED_APPLICATION_CPU_MIN_USAGE_PERCENT>}

\subsection application_monitoring_attr_application_cpu_max_usage_percent ApplicationMonitoring/ApplicationCPUMaxUsagePercent Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/ApplicationCPUMaxUsagePercent/Reported
[PREFIX]/ApplicationMonitoring/Attributes/ApplicationCPUMaxUsagePercent/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster ApplicationCPUMaxUsagePercent Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ApplicationCPUMaxUsagePercent attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/ApplicationCPUMaxUsagePercent/+'

# Example output

ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/ApplicationCPUMaxUsagePercent/Desired { "value": <DESIRED_APPLICATION_CPU_MAX_USAGE_PERCENT>}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/ApplicationCPUMaxUsagePercent/Reported { "value": <REPORTED_APPLICATION_CPU_MAX_USAGE_PERCENT>}

\subsection application_monitoring_attr_application_ram_usagemb ApplicationMonitoring/ApplicationRAMUsageMB Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/ApplicationRAMUsageMB/Reported
[PREFIX]/ApplicationMonitoring/Attributes/ApplicationRAMUsageMB/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster ApplicationRAMUsageMB Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ApplicationRAMUsageMB attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/ApplicationRAMUsageMB/+'

# Example output

ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/ApplicationRAMUsageMB/Desired { "value": <DESIRED_APPLICATION_RAM_USAGEMB>}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/ApplicationRAMUsageMB/Reported { "value": <REPORTED_APPLICATION_RAM_USAGEMB>}

\subsection application_monitoring_attr_cluster_revision ApplicationMonitoring/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/ClusterRevision/Reported
[PREFIX]/ApplicationMonitoring/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ApplicationMonitoring/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/ApplicationMonitoring/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/ApplicationMonitoring/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section application_monitoring_recv_cmd_support ApplicationMonitoring Command Support

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/SupportedCommands
[PREFIX]/ApplicationMonitoring/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
              "LogEntry",
              "WriteAttributes",
              "ForceReadAttributes"
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for ApplicationMonitoring cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/ApplicationMonitoring/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/ApplicationMonitoring/SupportedCommands { "value": ["LogEntry","WriteAttributes", "ForceReadAttributes"] }

To see supported generated commands for ApplicationMonitoring cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/ApplicationMonitoring/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/ApplicationMonitoring/SupportedGeneratedCommands { "value": [] }

\section application_monitoring_cmds ApplicationMonitoring Commands

\subsection application_monitoring_log_entry_cmd ApplicationMonitoring/LogEntry Command

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Commands/LogEntry
[PREFIX]/ApplicationMonitoring/GeneratedCommands/LogEntry

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster LogEntry Command Properties",
  "type": "object",
  "properties": {
    "Timestamp": {
      "type": "string"
    },
    "LogLevel": {
      "type": "LoggingLevelEnum"
    },
    "LogTag": {
      "type": "string"
    },
    "LogMessage": {
      "type": "string"
    }
  },
  "required": [
    "Timestamp",
    "LogLevel",
    "LogTag",
    "LogMessage"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ApplicationMonitoring/LogEntry command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/ApplicationMonitoring/Commands/LogEntry' -m  '{ "Timestamp": <TIMESTAMP_VALUE>,"LogLevel": <LOG_LEVEL_VALUE>,"LogTag": <LOG_TAG_VALUE>,"LogMessage": <LOG_MESSAGE_VALUE> }'

To receive a ApplicationMonitoring/LogEntry generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/ApplicationMonitoring/GeneratedCommands/LogEntry'

\subsection application_monitoring_write_attr_cmd ApplicationMonitoring/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
    "MQTTLoggingEnabled": {
      "type": "boolean"
    },
    "MQTTLoggingLevel": {
      "type": "LoggingLevelEnum"
    },
    "MQTTStatisticsReportingIntervalSeconds": {
      "type": "integer"
    },
    "ApplicationStatisticsReportingIntervalSeconds": {
      "type": "integer"
    },
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all ApplicationMonitoring attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ApplicationMonitoring/Commands/WriteAttributes' -m  '{ "MQTTLoggingEnabled": <MQTT_LOGGING_ENABLED_VALUE> ,"MQTTLoggingLevel": <MQTT_LOGGING_LEVEL_VALUE> ,"MQTTStatisticsReportingIntervalSeconds": <MQTT_STATISTICS_REPORTING_INTERVAL_SECONDS_VALUE> ,"ApplicationStatisticsReportingIntervalSeconds": <APPLICATION_STATISTICS_REPORTING_INTERVAL_SECONDS_VALUE> , }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection application_monitoring_force_read_attr_cmd ApplicationMonitoring/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "ApplicationName",
          "ApplicationVersion",
          "ApplicationConnected",
          "ApplicationMQTTTopics",
          "UptimeMinutes",
          "ProcessId",
          "Hostname",
          "FQDN",
          "MQTTLoggingEnabled",
          "MQTTLoggingLevel",
          "MQTTStatisticsReportingIntervalSeconds",
          "MQTTMessagesSent",
          "MQTTMessagesReceived",
          "MQTTSubscriptionCount",
          "MQTTAverageDeliveryTimeSeconds",
          "MQTTMinDeliveryTimeSeconds",
          "MQTTMaxDeliveryTimeSeconds",
          "ApplicationStatisticsReportingIntervalSeconds",
          "ApplicationCPUUsagePercent",
          "ApplicationCPUAverageUsagePercent",
          "ApplicationCPUMinUsagePercent",
          "ApplicationCPUMaxUsagePercent",
          "ApplicationRAMUsageMB"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all ApplicationMonitoring attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ApplicationMonitoring/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the ApplicationMonitoring attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ApplicationMonitoring/Commands/ForceReadAttributes' -m  '{ "value": ["ApplicationName"] }'

\page name_and_location NameAndLocation Cluster The following commands and attributes are accepted as JSON payloads for the NameAndLocation cluster.

\section name_and_location_attrs NameAndLocation Attributes The following attribute topics are used to retrieve the NameAndLocation cluster state.

\subsection name_and_location_attr_name NameAndLocation/Name Attribute

MQTT Topic Pattern:

[PREFIX]/NameAndLocation/Attributes/Name/Reported
[PREFIX]/NameAndLocation/Attributes/Name/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "NameAndLocation Cluster Name Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Name attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/NameAndLocation/Attributes/Name/+'

# Example output

ucl/by-unid/<UNID>/ep0/NameAndLocation/Attributes/Name/Desired { "value": <DESIRED_NAME>}
ucl/by-unid/<UNID>/ep0/NameAndLocation/Attributes/Name/Reported { "value": <REPORTED_NAME>}

\subsection name_and_location_attr_location NameAndLocation/Location Attribute

MQTT Topic Pattern:

[PREFIX]/NameAndLocation/Attributes/Location/Reported
[PREFIX]/NameAndLocation/Attributes/Location/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "NameAndLocation Cluster Location Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Location attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/NameAndLocation/Attributes/Location/+'

# Example output

ucl/by-unid/<UNID>/ep0/NameAndLocation/Attributes/Location/Desired { "value": <DESIRED_LOCATION>}
ucl/by-unid/<UNID>/ep0/NameAndLocation/Attributes/Location/Reported { "value": <REPORTED_LOCATION>}

\subsection name_and_location_attr_cluster_revision NameAndLocation/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/NameAndLocation/Attributes/ClusterRevision/Reported
[PREFIX]/NameAndLocation/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "NameAndLocation Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/NameAndLocation/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/NameAndLocation/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/NameAndLocation/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section name_and_location_recv_cmd_support NameAndLocation Command Support

MQTT Topic Pattern:

[PREFIX]/NameAndLocation/SupportedCommands
[PREFIX]/NameAndLocation/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "NameAndLocation Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for NameAndLocation cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/NameAndLocation/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/NameAndLocation/SupportedCommands { "value": [] }

To see supported generated commands for NameAndLocation cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/NameAndLocation/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/NameAndLocation/SupportedGeneratedCommands { "value": [] }

\section name_and_location_cmds NameAndLocation Commands

\subsection name_and_location_write_attr_cmd NameAndLocation/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/NameAndLocation/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "NameAndLocation Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
    "Name": {
      "type": "string"
    },
    "Location": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all NameAndLocation attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/NameAndLocation/Commands/WriteAttributes' -m  '{ "Name": <NAME_VALUE> ,"Location": <LOCATION_VALUE>  }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection name_and_location_force_read_attr_cmd NameAndLocation/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/NameAndLocation/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "NameAndLocation Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "Name",
          "Location"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all NameAndLocation attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/NameAndLocation/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the NameAndLocation attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/NameAndLocation/Commands/ForceReadAttributes' -m  '{ "value": ["Name"] }'

\page configuration_parameters ConfigurationParameters Cluster The following commands and attributes are accepted as JSON payloads for the ConfigurationParameters cluster.

\section configuration_parameters_attrs ConfigurationParameters Attributes The following attribute topics are used to retrieve the ConfigurationParameters cluster state.

\subsection configuration_parameters_attr_configuration_parameters ConfigurationParameters/ConfigurationParameters Attribute

MQTT Topic Pattern:

[PREFIX]/ConfigurationParameters/Attributes/ConfigurationParameters/Reported
[PREFIX]/ConfigurationParameters/Attributes/ConfigurationParameters/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ConfigurationParameters Cluster ConfigurationParameters Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "type": "ConfigurationParameter"
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ConfigurationParameters attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/ConfigurationParameters/Attributes/ConfigurationParameters/+'

# Example output

ucl/by-unid/<UNID>/ep0/ConfigurationParameters/Attributes/ConfigurationParameters/Desired { "value": [<DESIRED_CONFIGURATION_PARAMETERS>,<DESIRED_CONFIGURATION_PARAMETERS>]}
ucl/by-unid/<UNID>/ep0/ConfigurationParameters/Attributes/ConfigurationParameters/Reported { "value": [<REPORTED_CONFIGURATION_PARAMETERS>,<REPORTED_CONFIGURATION_PARAMETERS>]}

\subsection configuration_parameters_attr_cluster_revision ConfigurationParameters/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/ConfigurationParameters/Attributes/ClusterRevision/Reported
[PREFIX]/ConfigurationParameters/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ConfigurationParameters Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ConfigurationParameters/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/ConfigurationParameters/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/ConfigurationParameters/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section configuration_parameters_recv_cmd_support ConfigurationParameters Command Support

MQTT Topic Pattern:

[PREFIX]/ConfigurationParameters/SupportedCommands
[PREFIX]/ConfigurationParameters/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ConfigurationParameters Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
              "DiscoverParameter",
              "DefaultResetAllParameters",
              "SetParameter",
              "DiscoverParameterRange",
              "WriteAttributes",
              "ForceReadAttributes"
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for ConfigurationParameters cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ConfigurationParameters/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/ConfigurationParameters/SupportedCommands { "value": ["DiscoverParameter","DefaultResetAllParameters","SetParameter","DiscoverParameterRange","WriteAttributes", "ForceReadAttributes"] }

To see supported generated commands for ConfigurationParameters cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ConfigurationParameters/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/ConfigurationParameters/SupportedGeneratedCommands { "value": [] }

\section configuration_parameters_cmds ConfigurationParameters Commands

\subsection configuration_parameters_discover_parameter_cmd ConfigurationParameters/DiscoverParameter Command

MQTT Topic Pattern:

[PREFIX]/ConfigurationParameters/Commands/DiscoverParameter
[PREFIX]/ConfigurationParameters/GeneratedCommands/DiscoverParameter

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ConfigurationParameters Cluster DiscoverParameter Command Properties",
  "type": "object",
  "properties": {
    "ParameterId": {
      "type": "integer"
    }
  },
  "required": [
    "ParameterId"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ConfigurationParameters/DiscoverParameter command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ConfigurationParameters/Commands/DiscoverParameter' -m  '{ "ParameterId": <PARAMETER_ID_VALUE> }'

To receive a ConfigurationParameters/DiscoverParameter generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ConfigurationParameters/GeneratedCommands/DiscoverParameter'

\subsection configuration_parameters_default_reset_all_parameters_cmd ConfigurationParameters/DefaultResetAllParameters Command

MQTT Topic Pattern:

[PREFIX]/ConfigurationParameters/Commands/DefaultResetAllParameters
[PREFIX]/ConfigurationParameters/GeneratedCommands/DefaultResetAllParameters

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ConfigurationParameters Cluster DefaultResetAllParameters Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
  ]
}

Example Mosquitto CLI Tool Usage

To send a ConfigurationParameters/DefaultResetAllParameters command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ConfigurationParameters/Commands/DefaultResetAllParameters' -m  '{  }'

To receive a ConfigurationParameters/DefaultResetAllParameters generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ConfigurationParameters/GeneratedCommands/DefaultResetAllParameters'

\subsection configuration_parameters_set_parameter_cmd ConfigurationParameters/SetParameter Command

MQTT Topic Pattern:

[PREFIX]/ConfigurationParameters/Commands/SetParameter
[PREFIX]/ConfigurationParameters/GeneratedCommands/SetParameter

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ConfigurationParameters Cluster SetParameter Command Properties",
  "type": "object",
  "properties": {
    "ParameterId": {
      "type": "integer"
    },
    "Value": {
      "type": "integer"
    }
  },
  "required": [
    "ParameterId",
    "Value"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ConfigurationParameters/SetParameter command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ConfigurationParameters/Commands/SetParameter' -m  '{ "ParameterId": <PARAMETER_ID_VALUE>,"Value": <VALUE_VALUE> }'

To receive a ConfigurationParameters/SetParameter generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ConfigurationParameters/GeneratedCommands/SetParameter'

\subsection configuration_parameters_discover_parameter_range_cmd ConfigurationParameters/DiscoverParameterRange Command

MQTT Topic Pattern:

[PREFIX]/ConfigurationParameters/Commands/DiscoverParameterRange
[PREFIX]/ConfigurationParameters/GeneratedCommands/DiscoverParameterRange

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ConfigurationParameters Cluster DiscoverParameterRange Command Properties",
  "type": "object",
  "properties": {
    "FirstParameterId": {
      "type": "integer"
    },
    "LastParameterId": {
      "type": "integer"
    }
  },
  "required": [
    "FirstParameterId",
    "LastParameterId"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ConfigurationParameters/DiscoverParameterRange command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ConfigurationParameters/Commands/DiscoverParameterRange' -m  '{ "FirstParameterId": <FIRST_PARAMETER_ID_VALUE>,"LastParameterId": <LAST_PARAMETER_ID_VALUE> }'

To receive a ConfigurationParameters/DiscoverParameterRange generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ConfigurationParameters/GeneratedCommands/DiscoverParameterRange'

\subsection configuration_parameters_write_attr_cmd ConfigurationParameters/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/ConfigurationParameters/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ConfigurationParameters Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all ConfigurationParameters attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ConfigurationParameters/Commands/WriteAttributes' -m  '{  }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection configuration_parameters_force_read_attr_cmd ConfigurationParameters/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/ConfigurationParameters/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ConfigurationParameters Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "ConfigurationParameters"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all ConfigurationParameters attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ConfigurationParameters/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the ConfigurationParameters attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ConfigurationParameters/Commands/ForceReadAttributes' -m  '{ "value": ["ConfigurationParameters"] }'

\page aox_locator AoXLocator Cluster The following commands and attributes are accepted as JSON payloads for the AoXLocator cluster.

\section aox_locator_attrs AoXLocator Attributes The following attribute topics are used to retrieve the AoXLocator cluster state.

\subsection aox_locator_attr_reporting_mode AoXLocator/ReportingMode Attribute

MQTT Topic Pattern:

[PREFIX]/AoXLocator/Attributes/ReportingMode/Reported
[PREFIX]/AoXLocator/Attributes/ReportingMode/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AoXLocator Cluster ReportingMode Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "AoXLocatorReportingMode"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ReportingMode attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/AoXLocator/Attributes/ReportingMode/+'

# Example output

ucl/by-unid/<UNID>/ep0/AoXLocator/Attributes/ReportingMode/Desired { "value": <DESIRED_REPORTING_MODE>}
ucl/by-unid/<UNID>/ep0/AoXLocator/Attributes/ReportingMode/Reported { "value": <REPORTED_REPORTING_MODE>}

\subsection aox_locator_attr_position_and_orientation_valid AoXLocator/PositionAndOrientationValid Attribute

MQTT Topic Pattern:

[PREFIX]/AoXLocator/Attributes/PositionAndOrientationValid/Reported
[PREFIX]/AoXLocator/Attributes/PositionAndOrientationValid/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AoXLocator Cluster PositionAndOrientationValid Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "boolean"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for PositionAndOrientationValid attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/AoXLocator/Attributes/PositionAndOrientationValid/+'

# Example output

ucl/by-unid/<UNID>/ep0/AoXLocator/Attributes/PositionAndOrientationValid/Desired { "value": <DESIRED_POSITION_AND_ORIENTATION_VALID>}
ucl/by-unid/<UNID>/ep0/AoXLocator/Attributes/PositionAndOrientationValid/Reported { "value": <REPORTED_POSITION_AND_ORIENTATION_VALID>}

\subsection aox_locator_attr_position_and_orientation AoXLocator/PositionAndOrientation Attribute

MQTT Topic Pattern:

[PREFIX]/AoXLocator/Attributes/PositionAndOrientation/Reported
[PREFIX]/AoXLocator/Attributes/PositionAndOrientation/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AoXLocator Cluster PositionAndOrientation Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "CoordinateAndOrientation"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for PositionAndOrientation attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/AoXLocator/Attributes/PositionAndOrientation/+'

# Example output

ucl/by-unid/<UNID>/ep0/AoXLocator/Attributes/PositionAndOrientation/Desired { "value": <DESIRED_POSITION_AND_ORIENTATION>}
ucl/by-unid/<UNID>/ep0/AoXLocator/Attributes/PositionAndOrientation/Reported { "value": <REPORTED_POSITION_AND_ORIENTATION>}

\subsection aox_locator_attr_azimuth_mask AoXLocator/AzimuthMask Attribute

MQTT Topic Pattern:

[PREFIX]/AoXLocator/Attributes/AzimuthMask/Reported
[PREFIX]/AoXLocator/Attributes/AzimuthMask/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AoXLocator Cluster AzimuthMask Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "type": "MinMaxPair"
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for AzimuthMask attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/AoXLocator/Attributes/AzimuthMask/+'

# Example output

ucl/by-unid/<UNID>/ep0/AoXLocator/Attributes/AzimuthMask/Desired { "value": [<DESIRED_AZIMUTH_MASK>,<DESIRED_AZIMUTH_MASK>]}
ucl/by-unid/<UNID>/ep0/AoXLocator/Attributes/AzimuthMask/Reported { "value": [<REPORTED_AZIMUTH_MASK>,<REPORTED_AZIMUTH_MASK>]}

\subsection aox_locator_attr_elevation_mask AoXLocator/ElevationMask Attribute

MQTT Topic Pattern:

[PREFIX]/AoXLocator/Attributes/ElevationMask/Reported
[PREFIX]/AoXLocator/Attributes/ElevationMask/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AoXLocator Cluster ElevationMask Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "type": "MinMaxPair"
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ElevationMask attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/AoXLocator/Attributes/ElevationMask/+'

# Example output

ucl/by-unid/<UNID>/ep0/AoXLocator/Attributes/ElevationMask/Desired { "value": [<DESIRED_ELEVATION_MASK>,<DESIRED_ELEVATION_MASK>]}
ucl/by-unid/<UNID>/ep0/AoXLocator/Attributes/ElevationMask/Reported { "value": [<REPORTED_ELEVATION_MASK>,<REPORTED_ELEVATION_MASK>]}

\subsection aox_locator_attr_allow_list AoXLocator/AllowList Attribute

MQTT Topic Pattern:

[PREFIX]/AoXLocator/Attributes/AllowList/Reported
[PREFIX]/AoXLocator/Attributes/AllowList/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AoXLocator Cluster AllowList Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for AllowList attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/AoXLocator/Attributes/AllowList/+'

# Example output

ucl/by-unid/<UNID>/ep0/AoXLocator/Attributes/AllowList/Desired { "value": [<DESIRED_ALLOW_LIST>,<DESIRED_ALLOW_LIST>]}
ucl/by-unid/<UNID>/ep0/AoXLocator/Attributes/AllowList/Reported { "value": [<REPORTED_ALLOW_LIST>,<REPORTED_ALLOW_LIST>]}

\subsection aox_locator_attr_aox_mode AoXLocator/AoXMode Attribute

MQTT Topic Pattern:

[PREFIX]/AoXLocator/Attributes/AoXMode/Reported
[PREFIX]/AoXLocator/Attributes/AoXMode/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AoXLocator Cluster AoXMode Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "AoXLocatorAoXMode"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for AoXMode attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/AoXLocator/Attributes/AoXMode/+'

# Example output

ucl/by-unid/<UNID>/ep0/AoXLocator/Attributes/AoXMode/Desired { "value": <DESIRED_AOX_MODE>}
ucl/by-unid/<UNID>/ep0/AoXLocator/Attributes/AoXMode/Reported { "value": <REPORTED_AOX_MODE>}

\subsection aox_locator_attr_antenna_mode AoXLocator/AntennaMode Attribute

MQTT Topic Pattern:

[PREFIX]/AoXLocator/Attributes/AntennaMode/Reported
[PREFIX]/AoXLocator/Attributes/AntennaMode/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AoXLocator Cluster AntennaMode Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "AoXLocatorAntennaMode"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for AntennaMode attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/AoXLocator/Attributes/AntennaMode/+'

# Example output

ucl/by-unid/<UNID>/ep0/AoXLocator/Attributes/AntennaMode/Desired { "value": <DESIRED_ANTENNA_MODE>}
ucl/by-unid/<UNID>/ep0/AoXLocator/Attributes/AntennaMode/Reported { "value": <REPORTED_ANTENNA_MODE>}

\subsection aox_locator_attr_antenna_array AoXLocator/AntennaArray Attribute

MQTT Topic Pattern:

[PREFIX]/AoXLocator/Attributes/AntennaArray/Reported
[PREFIX]/AoXLocator/Attributes/AntennaArray/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AoXLocator Cluster AntennaArray Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "type": "integer"
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for AntennaArray attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/AoXLocator/Attributes/AntennaArray/+'

# Example output

ucl/by-unid/<UNID>/ep0/AoXLocator/Attributes/AntennaArray/Desired { "value": [<DESIRED_ANTENNA_ARRAY>,<DESIRED_ANTENNA_ARRAY>]}
ucl/by-unid/<UNID>/ep0/AoXLocator/Attributes/AntennaArray/Reported { "value": [<REPORTED_ANTENNA_ARRAY>,<REPORTED_ANTENNA_ARRAY>]}

\subsection aox_locator_attr_period_samples AoXLocator/PeriodSamples Attribute

MQTT Topic Pattern:

[PREFIX]/AoXLocator/Attributes/PeriodSamples/Reported
[PREFIX]/AoXLocator/Attributes/PeriodSamples/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AoXLocator Cluster PeriodSamples Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for PeriodSamples attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/AoXLocator/Attributes/PeriodSamples/+'

# Example output

ucl/by-unid/<UNID>/ep0/AoXLocator/Attributes/PeriodSamples/Desired { "value": <DESIRED_PERIOD_SAMPLES>}
ucl/by-unid/<UNID>/ep0/AoXLocator/Attributes/PeriodSamples/Reported { "value": <REPORTED_PERIOD_SAMPLES>}

\subsection aox_locator_attr_angle_filtering AoXLocator/AngleFiltering Attribute

MQTT Topic Pattern:

[PREFIX]/AoXLocator/Attributes/AngleFiltering/Reported
[PREFIX]/AoXLocator/Attributes/AngleFiltering/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AoXLocator Cluster AngleFiltering Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "boolean"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for AngleFiltering attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/AoXLocator/Attributes/AngleFiltering/+'

# Example output

ucl/by-unid/<UNID>/ep0/AoXLocator/Attributes/AngleFiltering/Desired { "value": <DESIRED_ANGLE_FILTERING>}
ucl/by-unid/<UNID>/ep0/AoXLocator/Attributes/AngleFiltering/Reported { "value": <REPORTED_ANGLE_FILTERING>}

\subsection aox_locator_attr_angle_filtering_weight AoXLocator/AngleFilteringWeight Attribute

MQTT Topic Pattern:

[PREFIX]/AoXLocator/Attributes/AngleFilteringWeight/Reported
[PREFIX]/AoXLocator/Attributes/AngleFilteringWeight/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AoXLocator Cluster AngleFilteringWeight Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for AngleFilteringWeight attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/AoXLocator/Attributes/AngleFilteringWeight/+'

# Example output

ucl/by-unid/<UNID>/ep0/AoXLocator/Attributes/AngleFilteringWeight/Desired { "value": <DESIRED_ANGLE_FILTERING_WEIGHT>}
ucl/by-unid/<UNID>/ep0/AoXLocator/Attributes/AngleFilteringWeight/Reported { "value": <REPORTED_ANGLE_FILTERING_WEIGHT>}

\subsection aox_locator_attr_angle_correction_timeout AoXLocator/AngleCorrectionTimeout Attribute

MQTT Topic Pattern:

[PREFIX]/AoXLocator/Attributes/AngleCorrectionTimeout/Reported
[PREFIX]/AoXLocator/Attributes/AngleCorrectionTimeout/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AoXLocator Cluster AngleCorrectionTimeout Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for AngleCorrectionTimeout attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/AoXLocator/Attributes/AngleCorrectionTimeout/+'

# Example output

ucl/by-unid/<UNID>/ep0/AoXLocator/Attributes/AngleCorrectionTimeout/Desired { "value": <DESIRED_ANGLE_CORRECTION_TIMEOUT>}
ucl/by-unid/<UNID>/ep0/AoXLocator/Attributes/AngleCorrectionTimeout/Reported { "value": <REPORTED_ANGLE_CORRECTION_TIMEOUT>}

\subsection aox_locator_attr_angle_correction_delay AoXLocator/AngleCorrectionDelay Attribute

MQTT Topic Pattern:

[PREFIX]/AoXLocator/Attributes/AngleCorrectionDelay/Reported
[PREFIX]/AoXLocator/Attributes/AngleCorrectionDelay/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AoXLocator Cluster AngleCorrectionDelay Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for AngleCorrectionDelay attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/AoXLocator/Attributes/AngleCorrectionDelay/+'

# Example output

ucl/by-unid/<UNID>/ep0/AoXLocator/Attributes/AngleCorrectionDelay/Desired { "value": <DESIRED_ANGLE_CORRECTION_DELAY>}
ucl/by-unid/<UNID>/ep0/AoXLocator/Attributes/AngleCorrectionDelay/Reported { "value": <REPORTED_ANGLE_CORRECTION_DELAY>}

\subsection aox_locator_attr_cte_mode AoXLocator/CTEMode Attribute

MQTT Topic Pattern:

[PREFIX]/AoXLocator/Attributes/CTEMode/Reported
[PREFIX]/AoXLocator/Attributes/CTEMode/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AoXLocator Cluster CTEMode Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "AoXLocatorCTEMode"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CTEMode attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/AoXLocator/Attributes/CTEMode/+'

# Example output

ucl/by-unid/<UNID>/ep0/AoXLocator/Attributes/CTEMode/Desired { "value": <DESIRED_CTE_MODE>}
ucl/by-unid/<UNID>/ep0/AoXLocator/Attributes/CTEMode/Reported { "value": <REPORTED_CTE_MODE>}

\subsection aox_locator_attr_cte_sampling_interval AoXLocator/CTESamplingInterval Attribute

MQTT Topic Pattern:

[PREFIX]/AoXLocator/Attributes/CTESamplingInterval/Reported
[PREFIX]/AoXLocator/Attributes/CTESamplingInterval/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AoXLocator Cluster CTESamplingInterval Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CTESamplingInterval attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/AoXLocator/Attributes/CTESamplingInterval/+'

# Example output

ucl/by-unid/<UNID>/ep0/AoXLocator/Attributes/CTESamplingInterval/Desired { "value": <DESIRED_CTE_SAMPLING_INTERVAL>}
ucl/by-unid/<UNID>/ep0/AoXLocator/Attributes/CTESamplingInterval/Reported { "value": <REPORTED_CTE_SAMPLING_INTERVAL>}

\subsection aox_locator_attr_cte_length AoXLocator/CTELength Attribute

MQTT Topic Pattern:

[PREFIX]/AoXLocator/Attributes/CTELength/Reported
[PREFIX]/AoXLocator/Attributes/CTELength/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AoXLocator Cluster CTELength Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CTELength attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/AoXLocator/Attributes/CTELength/+'

# Example output

ucl/by-unid/<UNID>/ep0/AoXLocator/Attributes/CTELength/Desired { "value": <DESIRED_CTE_LENGTH>}
ucl/by-unid/<UNID>/ep0/AoXLocator/Attributes/CTELength/Reported { "value": <REPORTED_CTE_LENGTH>}

\subsection aox_locator_attr_slot_duration AoXLocator/SlotDuration Attribute

MQTT Topic Pattern:

[PREFIX]/AoXLocator/Attributes/SlotDuration/Reported
[PREFIX]/AoXLocator/Attributes/SlotDuration/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AoXLocator Cluster SlotDuration Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for SlotDuration attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/AoXLocator/Attributes/SlotDuration/+'

# Example output

ucl/by-unid/<UNID>/ep0/AoXLocator/Attributes/SlotDuration/Desired { "value": <DESIRED_SLOT_DURATION>}
ucl/by-unid/<UNID>/ep0/AoXLocator/Attributes/SlotDuration/Reported { "value": <REPORTED_SLOT_DURATION>}

\subsection aox_locator_attr_cluster_revision AoXLocator/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/AoXLocator/Attributes/ClusterRevision/Reported
[PREFIX]/AoXLocator/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AoXLocator Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/AoXLocator/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/AoXLocator/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/AoXLocator/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section aox_locator_recv_cmd_support AoXLocator Command Support

MQTT Topic Pattern:

[PREFIX]/AoXLocator/SupportedCommands
[PREFIX]/AoXLocator/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AoXLocator Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
              "IQReport",
              "AngleReport",
              "AngleCorrection",
              "WriteAttributes",
              "ForceReadAttributes"
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for AoXLocator cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/AoXLocator/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/AoXLocator/SupportedCommands { "value": ["IQReport","AngleReport","AngleCorrection","WriteAttributes", "ForceReadAttributes"] }

To see supported generated commands for AoXLocator cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/AoXLocator/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/AoXLocator/SupportedGeneratedCommands { "value": [] }

\section aox_locator_cmds AoXLocator Commands

\subsection aox_locator_iq_report_cmd AoXLocator/IQReport Command

MQTT Topic Pattern:

[PREFIX]/AoXLocator/Commands/IQReport
[PREFIX]/AoXLocator/GeneratedCommands/IQReport

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AoXLocator Cluster IQReport Command Properties",
  "type": "object",
  "properties": {
    "TagUnid": {
      "type": "string"
    },
    "Channel": {
      "type": "integer"
    },
    "RSSI": {
      "type": "integer"
    },
    "Samples": {
      "type": "array",
      "items": {
        "type": "integer"
      }
,
    "Sequence": {
      "type": "integer"
    }
  },
  "required": [
    "TagUnid",
    "Channel",
    "RSSI",
    "Samples",
    "Sequence"
  ]
}

Example Mosquitto CLI Tool Usage

To send a AoXLocator/IQReport command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/AoXLocator/Commands/IQReport' -m  '{ "TagUnid": <TAG_UNID_VALUE>,"Channel": <CHANNEL_VALUE>,"RSSI": <RSSI_VALUE>,"Samples": <SAMPLES_VALUE>,"Sequence": <SEQUENCE_VALUE> }'

To receive a AoXLocator/IQReport generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/AoXLocator/GeneratedCommands/IQReport'

\subsection aox_locator_angle_report_cmd AoXLocator/AngleReport Command

MQTT Topic Pattern:

[PREFIX]/AoXLocator/Commands/AngleReport
[PREFIX]/AoXLocator/GeneratedCommands/AngleReport

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AoXLocator Cluster AngleReport Command Properties",
  "type": "object",
  "properties": {
    "TagUnid": {
      "type": "string"
    },
    "Direction": {
      "type": "SphericalCoordinates"
    },
    "Deviation": {
      "type": "SphericalCoordinates"
    },
    "Sequence": {
      "type": "integer"
    }
  },
  "required": [
    "TagUnid",
    "Direction",
    "Deviation",
    "Sequence"
  ]
}

Example Mosquitto CLI Tool Usage

To send a AoXLocator/AngleReport command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/AoXLocator/Commands/AngleReport' -m  '{ "TagUnid": <TAG_UNID_VALUE>,"Direction": <DIRECTION_VALUE>,"Deviation": <DEVIATION_VALUE>,"Sequence": <SEQUENCE_VALUE> }'

To receive a AoXLocator/AngleReport generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/AoXLocator/GeneratedCommands/AngleReport'

\subsection aox_locator_angle_correction_cmd AoXLocator/AngleCorrection Command

MQTT Topic Pattern:

[PREFIX]/AoXLocator/Commands/AngleCorrection
[PREFIX]/AoXLocator/GeneratedCommands/AngleCorrection

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AoXLocator Cluster AngleCorrection Command Properties",
  "type": "object",
  "properties": {
    "TagUnid": {
      "type": "string"
    },
    "Direction": {
      "type": "SphericalCoordinates"
    },
    "Deviation": {
      "type": "SphericalCoordinates"
    },
    "Sequence": {
      "type": "integer"
    }
  },
  "required": [
    "TagUnid",
    "Direction",
    "Deviation",
    "Sequence"
  ]
}

Example Mosquitto CLI Tool Usage

To send a AoXLocator/AngleCorrection command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/AoXLocator/Commands/AngleCorrection' -m  '{ "TagUnid": <TAG_UNID_VALUE>,"Direction": <DIRECTION_VALUE>,"Deviation": <DEVIATION_VALUE>,"Sequence": <SEQUENCE_VALUE> }'

To receive a AoXLocator/AngleCorrection generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/AoXLocator/GeneratedCommands/AngleCorrection'

\subsection aox_locator_write_attr_cmd AoXLocator/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/AoXLocator/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AoXLocator Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
    "ReportingMode": {
      "type": "AoXLocatorReportingMode"
    },
    "PositionAndOrientationValid": {
      "type": "boolean"
    },
    "PositionAndOrientation": {
      "type": "CoordinateAndOrientation"
    },
    "AzimuthMask": {
      "type": "MinMaxPair"
    },
    "ElevationMask": {
      "type": "MinMaxPair"
    },
    "AllowList": {
      "type": "string"
    },
    "AoXMode": {
      "type": "AoXLocatorAoXMode"
    },
    "AntennaMode": {
      "type": "AoXLocatorAntennaMode"
    },
    "AntennaArray": {
      "type": "integer"
    },
    "PeriodSamples": {
      "type": "integer"
    },
    "AngleFiltering": {
      "type": "boolean"
    },
    "AngleFilteringWeight": {
      "type": "number"
    },
    "AngleCorrectionTimeout": {
      "type": "integer"
    },
    "AngleCorrectionDelay": {
      "type": "integer"
    },
    "CTEMode": {
      "type": "AoXLocatorCTEMode"
    },
    "CTESamplingInterval": {
      "type": "integer"
    },
    "CTELength": {
      "type": "integer"
    },
    "SlotDuration": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all AoXLocator attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/AoXLocator/Commands/WriteAttributes' -m  '{ "ReportingMode": <REPORTING_MODE_VALUE> ,"PositionAndOrientationValid": <POSITION_AND_ORIENTATION_VALID_VALUE> ,"PositionAndOrientation": <POSITION_AND_ORIENTATION_VALUE> ,"AzimuthMask": <AZIMUTH_MASK_VALUE> ,"ElevationMask": <ELEVATION_MASK_VALUE> ,"AllowList": <ALLOW_LIST_VALUE> ,"AoXMode": <AOX_MODE_VALUE> ,"AntennaMode": <ANTENNA_MODE_VALUE> ,"AntennaArray": <ANTENNA_ARRAY_VALUE> ,"PeriodSamples": <PERIOD_SAMPLES_VALUE> ,"AngleFiltering": <ANGLE_FILTERING_VALUE> ,"AngleFilteringWeight": <ANGLE_FILTERING_WEIGHT_VALUE> ,"AngleCorrectionTimeout": <ANGLE_CORRECTION_TIMEOUT_VALUE> ,"AngleCorrectionDelay": <ANGLE_CORRECTION_DELAY_VALUE> ,"CTEMode": <CTE_MODE_VALUE> ,"CTESamplingInterval": <CTE_SAMPLING_INTERVAL_VALUE> ,"CTELength": <CTE_LENGTH_VALUE> ,"SlotDuration": <SLOT_DURATION_VALUE>  }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection aox_locator_force_read_attr_cmd AoXLocator/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/AoXLocator/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AoXLocator Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "ReportingMode",
          "PositionAndOrientationValid",
          "PositionAndOrientation",
          "AzimuthMask",
          "ElevationMask",
          "AllowList",
          "AoXMode",
          "AntennaMode",
          "AntennaArray",
          "PeriodSamples",
          "AngleFiltering",
          "AngleFilteringWeight",
          "AngleCorrectionTimeout",
          "AngleCorrectionDelay",
          "CTEMode",
          "CTESamplingInterval",
          "CTELength",
          "SlotDuration"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all AoXLocator attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/AoXLocator/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the AoXLocator attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/AoXLocator/Commands/ForceReadAttributes' -m  '{ "value": ["ReportingMode"] }'

\page aox_position_estimation AoXPositionEstimation Cluster The following commands and attributes are accepted as JSON payloads for the AoXPositionEstimation cluster.

\section aox_position_estimation_attrs AoXPositionEstimation Attributes The following attribute topics are used to retrieve the AoXPositionEstimation cluster state.

\subsection aox_position_estimation_attr_position AoXPositionEstimation/Position Attribute

MQTT Topic Pattern:

[PREFIX]/AoXPositionEstimation/Attributes/Position/Reported
[PREFIX]/AoXPositionEstimation/Attributes/Position/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AoXPositionEstimation Cluster Position Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "EstimatedPosition"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Position attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/AoXPositionEstimation/Attributes/Position/+'

# Example output

ucl/by-unid/<UNID>/ep0/AoXPositionEstimation/Attributes/Position/Desired { "value": <DESIRED_POSITION>}
ucl/by-unid/<UNID>/ep0/AoXPositionEstimation/Attributes/Position/Reported { "value": <REPORTED_POSITION>}

\subsection aox_position_estimation_attr_cluster_revision AoXPositionEstimation/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/AoXPositionEstimation/Attributes/ClusterRevision/Reported
[PREFIX]/AoXPositionEstimation/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AoXPositionEstimation Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/AoXPositionEstimation/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/AoXPositionEstimation/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/AoXPositionEstimation/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section aox_position_estimation_recv_cmd_support AoXPositionEstimation Command Support

MQTT Topic Pattern:

[PREFIX]/AoXPositionEstimation/SupportedCommands
[PREFIX]/AoXPositionEstimation/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AoXPositionEstimation Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for AoXPositionEstimation cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/AoXPositionEstimation/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/AoXPositionEstimation/SupportedCommands { "value": [] }

To see supported generated commands for AoXPositionEstimation cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/AoXPositionEstimation/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/AoXPositionEstimation/SupportedGeneratedCommands { "value": [] }

\section aox_position_estimation_cmds AoXPositionEstimation Commands

\subsection aox_position_estimation_write_attr_cmd AoXPositionEstimation/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/AoXPositionEstimation/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AoXPositionEstimation Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all AoXPositionEstimation attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/AoXPositionEstimation/Commands/WriteAttributes' -m  '{  }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection aox_position_estimation_force_read_attr_cmd AoXPositionEstimation/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/AoXPositionEstimation/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AoXPositionEstimation Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "Position"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all AoXPositionEstimation attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/AoXPositionEstimation/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the AoXPositionEstimation attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/AoXPositionEstimation/Commands/ForceReadAttributes' -m  '{ "value": ["Position"] }'

\page protocol_controller_network_management ProtocolController/NetworkManagement Cluster The following commands and attributes are accepted as JSON payloads for the ProtocolController-NetworkManagement cluster.

\section protocol_controller_network_management_attrs ProtocolController/NetworkManagement Attributes The following attribute topics are used to retrieve the ProtocolController-NetworkManagement cluster state.

\subsection protocol_controller_network_management_attr_network_management_state ProtocolController-NetworkManagement/NetworkManagementState Attribute

MQTT Topic Pattern:

[PREFIX]/ProtocolController/NetworkManagement/Attributes/NetworkManagementState/Reported
[PREFIX]/ProtocolController/NetworkManagement/Attributes/NetworkManagementState/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ProtocolController/NetworkManagement Cluster NetworkManagementState Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "NetworkManagementState"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for NetworkManagementState attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ProtocolController/NetworkManagement/Attributes/NetworkManagementState/+'

# Example output

ucl/by-unid/<UNID>/ProtocolController/NetworkManagement/Attributes/NetworkManagementState/Desired { "value": <DESIRED_NETWORK_MANAGEMENT_STATE>}
ucl/by-unid/<UNID>/ProtocolController/NetworkManagement/Attributes/NetworkManagementState/Reported { "value": <REPORTED_NETWORK_MANAGEMENT_STATE>}

\subsection protocol_controller_network_management_attr_cluster_revision ProtocolController/NetworkManagement/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/ProtocolController/NetworkManagement/Attributes/ClusterRevision/Reported
[PREFIX]/ProtocolController/NetworkManagement/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ProtocolController/NetworkManagement Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ProtocolController/NetworkManagement/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/ProtocolController/NetworkManagement/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/ProtocolController/NetworkManagement/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section protocol_controller_network_management_recv_cmd_support ProtocolController/NetworkManagement Command Support

MQTT Topic Pattern:

[PREFIX]/ProtocolController/NetworkManagement/SupportedCommands
[PREFIX]/ProtocolController/NetworkManagement/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ProtocolController/NetworkManagement Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
              "Write",
              "WriteAttributes",
              "ForceReadAttributes"
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for ProtocolController-NetworkManagement cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/ProtocolController/NetworkManagement/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/ProtocolController/NetworkManagement/SupportedCommands { "value": ["Write","WriteAttributes", "ForceReadAttributes"] }

To see supported generated commands for ProtocolController-NetworkManagement cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/ProtocolController/NetworkManagement/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/ProtocolController/NetworkManagement/SupportedGeneratedCommands { "value": [] }

\section protocol_controller_network_management_cmds ProtocolController/NetworkManagement Commands

\subsection protocol_controller_network_management_write_cmd ProtocolController/NetworkManagement/Write Command

MQTT Topic Pattern:

[PREFIX]/ProtocolController/NetworkManagement/Commands/Write
[PREFIX]/ProtocolController/NetworkManagement/GeneratedCommands/Write

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ProtocolController/NetworkManagement Cluster Write Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
  ]
}

Example Mosquitto CLI Tool Usage

To send a ProtocolController/NetworkManagement/Write command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/ProtocolController/NetworkManagement/Commands/Write' -m  '{  }'

To receive a ProtocolController/NetworkManagement/Write generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/ProtocolController/NetworkManagement/GeneratedCommands/Write'

\subsection protocol_controller_network_management_write_attr_cmd ProtocolController/NetworkManagement/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/ProtocolController/NetworkManagement/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ProtocolController/NetworkManagement Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all ProtocolController/NetworkManagement attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ProtocolController/NetworkManagement/Commands/WriteAttributes' -m  '{  }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection protocol_controller_network_management_force_read_attr_cmd ProtocolController/NetworkManagement/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/ProtocolController/NetworkManagement/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ProtocolController/NetworkManagement Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "NetworkManagementState"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all ProtocolController/NetworkManagement attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ProtocolController/NetworkManagement/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the ProtocolController/NetworkManagement attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ProtocolController/NetworkManagement/Commands/ForceReadAttributes' -m  '{ "value": ["NetworkManagementState"] }'

\page descriptor Descriptor Cluster The following commands and attributes are accepted as JSON payloads for the Descriptor cluster.

\section descriptor_attrs Descriptor Attributes The following attribute topics are used to retrieve the Descriptor cluster state.

\subsection descriptor_attr_device_type_list Descriptor/DeviceTypeList Attribute

MQTT Topic Pattern:

[PREFIX]/Descriptor/Attributes/DeviceTypeList/Reported
[PREFIX]/Descriptor/Attributes/DeviceTypeList/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Descriptor Cluster DeviceTypeList Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "type": "DeviceTypeStruct"
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DeviceTypeList attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Descriptor/Attributes/DeviceTypeList/+'

# Example output

ucl/by-unid/<UNID>/ep0/Descriptor/Attributes/DeviceTypeList/Desired { "value": [<DESIRED_DEVICE_TYPE_LIST>,<DESIRED_DEVICE_TYPE_LIST>]}
ucl/by-unid/<UNID>/ep0/Descriptor/Attributes/DeviceTypeList/Reported { "value": [<REPORTED_DEVICE_TYPE_LIST>,<REPORTED_DEVICE_TYPE_LIST>]}

\subsection descriptor_attr_cluster_revision Descriptor/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/Descriptor/Attributes/ClusterRevision/Reported
[PREFIX]/Descriptor/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Descriptor Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Descriptor/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/Descriptor/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/Descriptor/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

\section descriptor_recv_cmd_support Descriptor Command Support

MQTT Topic Pattern:

[PREFIX]/Descriptor/SupportedCommands
[PREFIX]/Descriptor/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Descriptor Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for Descriptor cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Descriptor/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/Descriptor/SupportedCommands { "value": [] }

To see supported generated commands for Descriptor cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Descriptor/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/Descriptor/SupportedGeneratedCommands { "value": [] }

\section descriptor_cmds Descriptor Commands

\subsection descriptor_write_attr_cmd Descriptor/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/Descriptor/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Descriptor Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all Descriptor attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Descriptor/Commands/WriteAttributes' -m  '{  }'

NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

\subsection descriptor_force_read_attr_cmd Descriptor/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/Descriptor/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Descriptor Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "DeviceTypeList"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all Descriptor attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Descriptor/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the Descriptor attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Descriptor/Commands/ForceReadAttributes' -m  '{ "value": ["DeviceTypeList"] }'

\page ucl_structs UCL Structs

NOTE: Not all struct types are used

\section struct_network_management_state NetworkManagementState Struct

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "NetworkManagementState Struct Properties",
  "type": "object",
  "properties": {
    "State": {
      "type": "NM_State"
    }
    "SupportedStateList": {
      "type": "string"
    }
    "StateParameters": {
      "type": "NM_StateParameters"
    }
    "RequestedStateParameters": {
      "type": "string"
    }
  }
}

\section struct_binding_object BindingObject Struct

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BindingObject Struct Properties",
  "type": "object",
  "properties": {
    "ClusterName": {
      "type": "string"
    }
    "DestinationUnid": {
      "type": "string"
    }
    "DestinationEp": {
      "type": "integer"
    }
  }
}

\section struct_configuration_parameter ConfigurationParameter Struct

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ConfigurationParameter Struct Properties",
  "type": "object",
  "properties": {
    "ParameterId": {
      "type": "integer"
    }
    "Value": {
      "type": "integer"
    }
    "Name": {
      "type": "string"
    }
    "Info": {
      "type": "string"
    }
    "MinimumValue": {
      "type": "integer"
    }
    "MaximumValue": {
      "type": "integer"
    }
    "DefaultValue": {
      "type": "integer"
    }
    "DisplayFormat": {
      "type": "DisplayFormat"
    }
    "ReadOnly": {
      "type": "boolean"
    }
    "Advanced": {
      "type": "boolean"
    }
    "AlteringCapabilities": {
      "type": "boolean"
    }
  }
}

\section struct_coordinate_and_orientation CoordinateAndOrientation Struct

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CoordinateAndOrientation Struct Properties",
  "type": "object",
  "properties": {
    "CoordinateX": {
      "type": "number"
    }
    "CoordinateY": {
      "type": "number"
    }
    "CoordinateZ": {
      "type": "number"
    }
    "OrientationX": {
      "type": "number"
    }
    "OrientationY": {
      "type": "number"
    }
    "OrientationZ": {
      "type": "number"
    }
  }
}

\section struct_credential_struct CredentialStruct Struct

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CredentialStruct Struct Properties",
  "type": "object",
  "properties": {
    "CredentialType": {
      "type": "CredentialTypeEnum"
    }
    "CredentialIndex": {
      "type": "integer"
    }
  }
}

\section struct_device_type_struct DeviceTypeStruct Struct

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DeviceTypeStruct Struct Properties",
  "type": "object",
  "properties": {
    "DeviceType": {
      "type": "DevTypeId"
    }
    "Revision": {
      "type": "integer"
    }
  }
}

\section struct_disk_io_counters DiskIOCounters Struct

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DiskIOCounters Struct Properties",
  "type": "object",
  "properties": {
    "UUID": {
      "type": "string"
    }
    "ReadCount": {
      "type": "integer"
    }
    "WriteCount": {
      "type": "integer"
    }
    "ReadBytes": {
      "type": "integer"
    }
    "WriteBytes": {
      "type": "integer"
    }
  }
}

\section struct_disk_usage_data DiskUsageData Struct

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DiskUsageData Struct Properties",
  "type": "object",
  "properties": {
    "UUID": {
      "type": "string"
    }
    "UsagePercent": {
      "type": "number"
    }
    "FreeSpaceMB": {
      "type": "number"
    }
  }
}

\section struct_estimated_position EstimatedPosition Struct

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "EstimatedPosition Struct Properties",
  "type": "object",
  "properties": {
    "ApplicationId": {
      "type": "string"
    }
    "X": {
      "type": "number"
    }
    "Y": {
      "type": "number"
    }
    "Z": {
      "type": "number"
    }
    "DeviationX": {
      "type": "number"
    }
    "DeviationY": {
      "type": "number"
    }
    "DeviationZ": {
      "type": "number"
    }
    "Sequence": {
      "type": "integer"
    }
  }
}

\section struct_min_max_pair MinMaxPair Struct

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "MinMaxPair Struct Properties",
  "type": "object",
  "properties": {
    "Min": {
      "type": "number"
    }
    "Max": {
      "type": "number"
    }
  }
}

\section struct_network_interface_data NetworkInterfaceData Struct

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "NetworkInterfaceData Struct Properties",
  "type": "object",
  "properties": {
    "InterfaceName": {
      "type": "string"
    }
    "BytesSent": {
      "type": "integer"
    }
    "BytesReceived": {
      "type": "integer"
    }
    "PacketsSent": {
      "type": "integer"
    }
    "PacketsReceived": {
      "type": "integer"
    }
    "ErrorsIn": {
      "type": "integer"
    }
    "ErrorsOut": {
      "type": "integer"
    }
    "DropIn": {
      "type": "integer"
    }
    "DropOut": {
      "type": "integer"
    }
  }
}

\section struct_s_extension_field_set_list SExtensionFieldSetList Struct

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SExtensionFieldSetList Struct Properties",
  "type": "object",
  "properties": {
    "ClusterId": {
      "type": "integer"
    }
    "ExtensionFieldSet": {
      "type": "string"
    }
  }
}

\section struct_s_scene_table SSceneTable Struct

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SSceneTable Struct Properties",
  "type": "object",
  "properties": {
    "SceneID": {
      "type": "integer"
    }
    "GroupID": {
      "type": "integer"
    }
    "SceneName": {
      "type": "string"
    }
    "TransitionTime": {
      "type": "integer"
    }
    "TransitionTime100ms": {
      "type": "integer"
    }
    "SceneTableExtensions": {
      "type": "string"
    }
  }
}

\section struct_spherical_coordinates SphericalCoordinates Struct

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SphericalCoordinates Struct Properties",
  "type": "object",
  "properties": {
    "Azimuth": {
      "type": "number"
    }
    "Elevation": {
      "type": "number"
    }
    "Distance": {
      "type": "number"
    }
  }
}

\section struct_transition_type TransitionType Struct

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "TransitionType Struct Properties",
  "type": "object",
  "properties": {
    "TransitionTime": {
      "type": "integer"
    }
    "HeatSetPoint": {
      "type": "integer"
    }
    "CoolSetPoint": {
      "type": "integer"
    }
  }
}

\section struct_wireless_network_interface_data WirelessNetworkInterfaceData Struct

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WirelessNetworkInterfaceData Struct Properties",
  "type": "object",
  "properties": {
    "InterfaceName": {
      "type": "string"
    }
    "SignalStrengthdBm": {
      "type": "number"
    }
  }
}

\page ucl_enums UCL Enums

NOTE: Not all enum types are used

\section enum_aox_locator_antenna_mode AoXLocatorAntennaMode Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AoXLocatorAntennaMode Enum Properties",
  "type": "string",
  "enum": [
    "Array 4x4 URA",
    "Array 3x3 URA",
    "Array 1x4 ULA",
    "Array 4x4 DP URA",
    "Array COREHW_15x15 DP",
    "Array COREHW 12x12 DP"
  ]
}

\section enum_aox_locator_aox_mode AoXLocatorAoXMode Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AoXLocatorAoXMode Enum Properties",
  "type": "string",
  "enum": [
    "One Shot Basic",
    "One Shot Basic Lightweight",
    "One Shot Fast Response",
    "One Shot High Accuracy",
    "One Shot Basic Azimuth Only",
    "One Shot Fast Response Azimuth Only",
    "One Shot High Accuracy Azimuth Only",
    "Real Time Fast Response",
    "Real Time Basic",
    "Real Time High Accuracy"
  ]
}

\section enum_aox_locator_cte_mode AoXLocatorCTEMode Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AoXLocatorCTEMode Enum Properties",
  "type": "string",
  "enum": [
    "Silicon Labs",
    "Connection",
    "Connectionless"
  ]
}

\section enum_aox_locator_reporting_mode AoXLocatorReportingMode Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AoXLocatorReportingMode Enum Properties",
  "type": "string",
  "enum": [
    "IQReport",
    "AngleReport"
  ]
}

\section enum_arm_arm_mode ArmArmMode Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ArmArmMode Enum Properties",
  "type": "string",
  "enum": [
    "Disarm",
    "ArmDayHomeZonesOnly",
    "ArmNightSleepZonesOnly",
    "ArmAllZones"
  ]
}

\section enum_arm_response_arm_notification ArmResponseArmNotification Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ArmResponseArmNotification Enum Properties",
  "type": "string",
  "enum": [
    "AllZonesDisarmed",
    "OnlyDayHomeZonesArmed",
    "OnlyNightSleepZonesArmed",
    "AllZonesArmed",
    "InvalidArmDisarmCode",
    "NotReadyToArm",
    "AlreadyDisarmed"
  ]
}

\section enum_barrier_control_moving_state BarrierControlMovingState Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BarrierControlMovingState Enum Properties",
  "type": "string",
  "enum": [
    "Stopped",
    "Closing",
    "Opening"
  ]
}

\section enum_basic_generic_device_class BasicGenericDeviceClass Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BasicGenericDevice-Class Enum Properties",
  "type": "string",
  "enum": [
    "Lighting"
  ]
}

\section enum_basic_generic_device_type BasicGenericDeviceType Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BasicGenericDevice-Type Enum Properties",
  "type": "string",
  "enum": [
    "Incandescent",
    "SpotlightHalogen",
    "HalogenBulb",
    "CFL",
    "LinearFluorescent",
    "LEDBulb",
    "SpotlightLED",
    "LEDStrip",
    "LEDTube",
    "GenericIndoorLuminaireOrLightFixture",
    "GenericOutdoorLuminaireOrLightFixture",
    "PendantLuminaireOrLightFixture",
    "FloorStandingLuminaireOrLightFixture",
    "GenericController",
    "WallSwitch",
    "PortableRemoteController",
    "MotionSensorOrLightSensor",
    "GenericActuator",
    "WallSocket",
    "GatewayOrBridge",
    "PlugInUnit",
    "RetrofitActuator",
    "Unspecified"
  ]
}

\section enum_basic_physical_environment BasicPhysicalEnvironment Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BasicPhysicalEnvironment Enum Properties",
  "type": "string",
  "enum": [
    "UnspecifiedEnvironment",
    "Deprecated",
    "Bar",
    "Courtyard",
    "Bathroom",
    "Bedroom",
    "BilliardRoom",
    "UtilityRoom",
    "Cellar",
    "StorageCloset",
    "Theater",
    "Office",
    "Deck",
    "Den",
    "DiningRoom",
    "ElectricalRoom",
    "Elevator",
    "Entry",
    "FamilyRoom",
    "MainFloor",
    "Upstairs",
    "Downstairs",
    "Basement/LowerLevel",
    "Gallery",
    "GameRoom",
    "Garage",
    "Gym",
    "Hallway",
    "House",
    "Kitchen",
    "LaundryRoom",
    "Library",
    "MasterBedroom",
    "MudRoom",
    "Nursery",
    "Pantry",
    "SecondaryOffice",
    "Outside",
    "Pool",
    "Porch",
    "SewingRoom",
    "SittingRoom",
    "Stairway",
    "Yard",
    "Attic",
    "HotTub",
    "LivingRoom",
    "Sauna",
    "ShopOrWorkshop",
    "GuestBedroom",
    "GuestBath",
    "PowderRoom",
    "BackYard",
    "FrontYard",
    "Patio",
    "Driveway",
    "SunRoom",
    "SecondaryLivingRoom",
    "Spa",
    "Whirlpool",
    "Shed",
    "EquipmentStorage",
    "HobbyOrCraftRoom",
    "Fountain",
    "Pond",
    "ReceptionRoom",
    "BreakfastRoom",
    "Nook",
    "Garden",
    "Balcony",
    "PanicRoom",
    "Terrace",
    "Roof",
    "Toilet",
    "ToiletMain",
    "OutsideToilet",
    "ShowerRoom",
    "Study",
    "FrontGarden",
    "BackGarden",
    "Kettle",
    "Television",
    "Stove",
    "Microwave",
    "Toaster",
    "Vacuum",
    "Appliance",
    "FrontDoor",
    "BackDoor",
    "FridgeDoor",
    "MedicationCabinetDoor",
    "WardrobeDoor",
    "FrontCupboardDoor",
    "OtherDoor",
    "WaitingRoom",
    "TriageRoom",
    "DoctorsOffice",
    "PatientsPrivateRoom",
    "ConsultationRoom",
    "NurseStation",
    "Ward",
    "Corridor",
    "OperatingTheatre",
    "DentalSurgeryRoom",
    "MedicalImagingRoom",
    "DecontaminationRoom",
    "Atrium",
    "Mirror",
    "UnknownEnvironment"
  ]
}

\section enum_basic_power_source BasicPowerSource Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BasicPowerSource Enum Properties",
  "type": "string",
  "enum": [
    "Unknown",
    "SinglePhaseMains",
    "ThreePhaseMains",
    "Battery",
    "DCSource",
    "EmergencyMainsConstantlyPowered",
    "EmergencyMainsAndTransferSwitch",
    "UnknownWithBatteryBackup",
    "SinglePhaseMainsWithBatteryBackup",
    "ThreePhaseMainsWithBatteryBackup",
    "BatteryWithBatteryBackup",
    "DCSourceWithBatteryBackup",
    "EmergencyMainsConstantlyPoweredWithBatteryBackup",
    "EmergencyMainsAndTransferSwitchWithBatteryBackup"
  ]
}

\section enum_battery_size BatterySize Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BatterySize Enum Properties",
  "type": "string",
  "enum": [
    "NoBattery",
    "BuiltIn",
    "Other",
    "AA",
    "AAA",
    "C",
    "D",
    "CR2",
    "CR123A",
    "Unknown"
  ]
}

\section enum_bypass_response_zone_id_bypass_result BypassResponseZoneIDBypassResult Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BypassResponseZoneIDBypassResult Enum Properties",
  "type": "string",
  "enum": [
    "ZoneBypassed",
    "ZoneNotBypassed",
    "NotAllowed",
    "InvalidZoneID",
    "UnknownZoneID",
    "InvalidArmDisarmCode"
  ]
}

\section enum_cc_color_loop_direction CCColorLoopDirection Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CCColorLoopDirection Enum Properties",
  "type": "string",
  "enum": [
    "DecrementEnhancedCurrentHue",
    "IncrementEnhancedCurrentHue"
  ]
}

\section enum_cc_direction CCDirection Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CCDirection Enum Properties",
  "type": "string",
  "enum": [
    "ShortestDistance",
    "LongestDistance",
    "Up",
    "Down"
  ]
}

\section enum_cc_move_mode CCMoveMode Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CCMoveMode Enum Properties",
  "type": "string",
  "enum": [
    "Stop",
    "Up",
    "Down"
  ]
}

\section enum_cc_step_mode CCStepMode Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CCStepMode Enum Properties",
  "type": "string",
  "enum": [
    "Up",
    "Down"
  ]
}

\section enum_color_control_color_loop_active ColorControlColorLoopActive Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControlColorLoopActive Enum Properties",
  "type": "string",
  "enum": [
    "ColorLoopInactive",
    "ColorLoopActive"
  ]
}

\section enum_color_control_color_mode ColorControlColorMode Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControlColorMode Enum Properties",
  "type": "string",
  "enum": [
    "CurrentHueAndCurrentSaturation",
    "CurrentXAndCurrentY",
    "ColorTemperatureMireds"
  ]
}

\section enum_color_control_drift_compensation ColorControlDriftCompensation Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControlDriftCompensation Enum Properties",
  "type": "string",
  "enum": [
    "None",
    "OtherOrUnknown",
    "TemperatureMonitoring",
    "OpticalLuminanceMonitoringAndFeedback",
    "OpticalColorMonitoringAndFeedback"
  ]
}

\section enum_color_control_enhanced_color_mode ColorControlEnhancedColorMode Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControlEnhancedColorMode Enum Properties",
  "type": "string",
  "enum": [
    "CurrentHueAndCurrentSaturation",
    "CurrentXAndCurrentY",
    "ColorTemperatureMireds",
    "EnhancedCurrentHueAndCurrentSaturation"
  ]
}

\section enum_color_loop_set_action ColorLoopSetAction Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorLoopSetAction Enum Properties",
  "type": "string",
  "enum": [
    "DeactivateColorLoop",
    "ActivateColorLoopFromColorLoopStartEnhancedHue",
    "ActivateColorLoopFromEnhancedCurrentHue"
  ]
}

\section enum_commissioning_network_key_type CommissioningNetworkKeyType Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CommissioningNetworkKeyType Enum Properties",
  "type": "string",
  "enum": [
    "StandardKey"
  ]
}

\section enum_commissioning_protocol_version CommissioningProtocolVersion Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CommissioningProtocolVersion Enum Properties",
  "type": "string",
  "enum": [
    "Zigbee2006OrLater"
  ]
}

\section enum_commissioning_stack_profile CommissioningStackProfile Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CommissioningStackProfile Enum Properties",
  "type": "string",
  "enum": [
    "ZigbeeStackProfile",
    "ZigbeeProStackProfile"
  ]
}

\section enum_commissioning_startup_control CommissioningStartupControl Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CommissioningStartupControl Enum Properties",
  "type": "string",
  "enum": [
    "OnANetwork",
    "FormNetwork",
    "RejoinNetwork",
    "JoinUsingMACAssociation"
  ]
}

\section enum_credential_rule_enum CredentialRuleEnum Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CredentialRuleEnum Enum Properties",
  "type": "string",
  "enum": [
    "Single",
    "Dual",
    "Tri"
  ]
}

\section enum_credential_type_enum CredentialTypeEnum Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CredentialTypeEnum Enum Properties",
  "type": "string",
  "enum": [
    "ProgrammingPIN",
    "PIN",
    "RFID",
    "Fingerprint",
    "FingerVein",
    "Face"
  ]
}

\section enum_data_operation_type_enum DataOperationTypeEnum Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DataOperationTypeEnum Enum Properties",
  "type": "string",
  "enum": [
    "Add",
    "Clear",
    "Modify"
  ]
}

\section enum_dehumidification_control_dehumidification_lockout DehumidificationControlDehumidificationLockout Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DehumidificationControlDehumidificationLockout Enum Properties",
  "type": "string",
  "enum": [
    "DehumidificationNotAllowed.",
    "DehumidificationAllowed."
  ]
}

\section enum_dehumidification_control_relative_humidity_display DehumidificationControlRelativeHumidityDisplay Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DehumidificationControlRelativeHumidityDisplay Enum Properties",
  "type": "string",
  "enum": [
    "NotDisplayed",
    "Displayed"
  ]
}

\section enum_dehumidification_control_relative_humidity_mode DehumidificationControlRelativeHumidityMode Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DehumidificationControlRelativeHumidityMode Enum Properties",
  "type": "string",
  "enum": [
    "MeasuredLocally",
    "UpdatedOverTheNetwork"
  ]
}

\section enum_dev_type_id DevTypeId Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DevTypeId Enum Properties",
  "type": "string",
  "enum": [
    "DoorLock",
    "DoorLockController",
    "Fan",
    "AirPurifier",
    "RoomAirConditioner",
    "Cooktop",
    "ExtractorHood",
    "OnOffLight",
    "DimmableLight",
    "OnOffLightSwitch",
    "DimmerSwitch",
    "ColorDimmerSwitch",
    "LightSensor",
    "OccupancySensor",
    "OnOffPluginUnit",
    "DimmablePlugInUnit",
    "ColorTemperatureLight",
    "ExtendedColorLight",
    "WindowCovering",
    "WindowCoveringController",
    "HeatingCoolingUnit",
    "Thermostat",
    "TemperatureSensor",
    "Pump",
    "PressureSensor",
    "FlowSensor",
    "HumiditySensor",
    "ControlBridge",
    "OnOffSensor"
  ]
}

\section enum_door_lock_door_state DoorLockDoorState Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLockDoorState Enum Properties",
  "type": "string",
  "enum": [
    "Open",
    "Closed",
    "ErrorJammed",
    "ErrorForcedOpen",
    "ErrorUnspecified",
    "DoorAjar",
    "Undefined"
  ]
}

\section enum_door_lock_led_settings DoorLockLEDSettings Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLockLEDSettings Enum Properties",
  "type": "string",
  "enum": [
    "NeverUseLED",
    "UseLEDExceptForAccessAllowed",
    "UseLEDForAllEvents"
  ]
}

\section enum_door_lock_lock_state DoorLockLockState Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLockLockState Enum Properties",
  "type": "string",
  "enum": [
    "NotFullyLocked",
    "Locked",
    "Unlocked",
    "Unlatched",
    "Undefined"
  ]
}

\section enum_door_lock_lock_type DoorLockLockType Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLockLockType Enum Properties",
  "type": "string",
  "enum": [
    "DeadBolt",
    "Magnetic",
    "Other",
    "Mortise",
    "Rim",
    "LatchBolt",
    "CylindricalLock",
    "TubularLock",
    "InterconnectedLock",
    "DeadLatch",
    "DoorFurniture",
    "Eurocylinder"
  ]
}

\section enum_door_lock_security_level DoorLockSecurityLevel Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLockSecurityLevel Enum Properties",
  "type": "string",
  "enum": [
    "Network",
    "APS"
  ]
}

\section enum_door_lock_sound_volume DoorLockSoundVolume Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLockSoundVolume Enum Properties",
  "type": "string",
  "enum": [
    "SilentMode",
    "LowVolume",
    "HighVolume",
    "MediumVolume"
  ]
}

\section enum_drlk_oper_event_source DrlkOperEventSource Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DrlkOperEventSource Enum Properties",
  "type": "string",
  "enum": [
    "Keypad",
    "RF",
    "Manual",
    "RFID",
    "Indeterminate"
  ]
}

\section enum_drlk_oper_mode DrlkOperMode Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DrlkOperMode Enum Properties",
  "type": "string",
  "enum": [
    "Normal",
    "Vacation",
    "Privacy",
    "NoRFLockOrUnlock",
    "Passage"
  ]
}

\section enum_drlk_pass_fail_status DrlkPassFailStatus Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DrlkPassFailStatus Enum Properties",
  "type": "string",
  "enum": [
    "Pass",
    "Fail"
  ]
}

\section enum_drlk_set_code_status DrlkSetCodeStatus Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DrlkSetCodeStatus Enum Properties",
  "type": "string",
  "enum": [
    "Success",
    "GeneralFailure",
    "MemoryFull",
    "DuplicateCode"
  ]
}

\section enum_drlk_settable_user_status DrlkSettableUserStatus Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DrlkSettableUserStatus Enum Properties",
  "type": "string",
  "enum": [
    "OccupiedEnabled",
    "OccupiedDisabled"
  ]
}

\section enum_drlk_user_status DrlkUserStatus Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DrlkUserStatus Enum Properties",
  "type": "string",
  "enum": [
    "Available",
    "OccupiedEnabled",
    "OccupiedDisabled",
    "NotSupported"
  ]
}

\section enum_drlk_user_type DrlkUserType Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DrlkUserType Enum Properties",
  "type": "string",
  "enum": [
    "UnrestrictedUser",
    "YearDayScheduleUser",
    "WeekDayScheduleUser",
    "MasterUser",
    "NonAccessUser",
    "ForcedUser",
    "DisposableUser",
    "ExpiringUser",
    "ScheduleRestrictedUser",
    "RemoteOnlyUser",
    "NotSupported"
  ]
}

\section enum_fan_control_fan_mode FanControlFanMode Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "FanControlFanMode Enum Properties",
  "type": "string",
  "enum": [
    "Off",
    "Low",
    "Medium",
    "High",
    "On",
    "Auto",
    "Smart"
  ]
}

\section enum_fan_control_fan_mode_sequence FanControlFanModeSequence Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "FanControlFanModeSequence Enum Properties",
  "type": "string",
  "enum": [
    "LowMedHigh",
    "LowHigh",
    "LowMedHighAuto",
    "LowHighAuto",
    "OnAuto"
  ]
}

\section enum_get_log_record_response_event_type GetLogRecordResponseEventType Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "GetLogRecordResponseEventType Enum Properties",
  "type": "string",
  "enum": [
    "Operation",
    "Programming",
    "Alarm"
  ]
}

\section enum_get_measurement_profile_response_status GetMeasurementProfileResponseStatus Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "GetMeasurementProfileResponseStatus Enum Properties",
  "type": "string",
  "enum": [
    "Success",
    "AttributeProfileNotSupported",
    "InvalidStartTime",
    "MoreIntervalsRequestedThanCanBeReturned",
    "NoIntervalsAvailableForTheRequestedTime"
  ]
}

\section enum_hvac_system_type_configuration_cooling_system_stage HVACSystemTypeConfigurationCoolingSystemStage Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "HVACSystemTypeConfigurationCoolingSystemStage Enum Properties",
  "type": "string",
  "enum": [
    "CoolStage1",
    "CoolStage2",
    "CoolStage3"
  ]
}

\section enum_hvac_system_type_configuration_heating_fuel_source HVACSystemTypeConfigurationHeatingFuelSource Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "HVACSystemTypeConfigurationHeatingFuelSource Enum Properties",
  "type": "string",
  "enum": [
    "ElectricOrB",
    "GasOrO"
  ]
}

\section enum_hvac_system_type_configuration_heating_system_stage HVACSystemTypeConfigurationHeatingSystemStage Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "HVACSystemTypeConfigurationHeatingSystemStage Enum Properties",
  "type": "string",
  "enum": [
    "HeatStage1",
    "HeatStage2",
    "HeatStage3"
  ]
}

\section enum_hvac_system_type_configuration_heating_system_type HVACSystemTypeConfigurationHeatingSystemType Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "HVACSystemTypeConfigurationHeatingSystemType Enum Properties",
  "type": "string",
  "enum": [
    "Conventional",
    "HeatPump"
  ]
}

\section enum_ias_zone_zone_state IASZoneZoneState Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IASZoneZoneState Enum Properties",
  "type": "string",
  "enum": [
    "NotEnrolled",
    "Enrolled"
  ]
}

\section enum_ias_zone_type IasZoneType Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IasZoneType Enum Properties",
  "type": "string",
  "enum": [
    "StandardCIE",
    "MotionSensor",
    "ContactSwitch",
    "DoorOrWindowHandle",
    "FireSensor",
    "WaterSensor",
    "CarbonMonoxideSensor",
    "PersonalEmergencyDevice",
    "VibrationOrMovementSensor",
    "RemoteControl",
    "KeyFob",
    "Keypad",
    "StandardWarningDevice",
    "GlassBreakSensor",
    "SecurityRepeater",
    "Invalid"
  ]
}

\section enum_iasac_panel_status IasacPanelStatus Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IasacPanelStatus Enum Properties",
  "type": "string",
  "enum": [
    "PanelDisarmedReadyToArm",
    "ArmedStay",
    "ArmedNight",
    "ArmedAway",
    "ExitDelay",
    "EntryDelay",
    "NotReadyToArm",
    "InAlarm",
    "ArmingStay",
    "ArmingNight",
    "ArmingAway"
  ]
}

\section enum_iasace_alarm_status IasaceAlarmStatus Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IasaceAlarmStatus Enum Properties",
  "type": "string",
  "enum": [
    "NoAlarm",
    "Burgler",
    "Fire",
    "Emergency",
    "PolicePanic",
    "FirePanic",
    "EmergencyPanic"
  ]
}

\section enum_iasace_audible_notification IasaceAudibleNotification Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IasaceAudibleNotification Enum Properties",
  "type": "string",
  "enum": [
    "Mute",
    "DefaultSound"
  ]
}

\section enum_iaswd_level IaswdLevel Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IaswdLevel Enum Properties",
  "type": "string",
  "enum": [
    "LowLevel",
    "MediumLevel",
    "HighLevel",
    "VeryHighLevel"
  ]
}

\section enum_illuminance_level_sensing_level_status IlluminanceLevelSensingLevelStatus Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IlluminanceLevelSensingLevelStatus Enum Properties",
  "type": "string",
  "enum": [
    "IlluminanceOnTarget",
    "IlluminanceBelowTarget",
    "IlluminanceAboveTarget"
  ]
}

\section enum_illuminance_level_sensing_light_sensor_type IlluminanceLevelSensingLightSensorType Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IlluminanceLevelSensingLightSensorType Enum Properties",
  "type": "string",
  "enum": [
    "Photodiode",
    "CMOS",
    "Unknown"
  ]
}

\section enum_illuminance_measurement_light_sensor_type IlluminanceMeasurementLightSensorType Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IlluminanceMeasurementLightSensorType Enum Properties",
  "type": "string",
  "enum": [
    "Photodiode",
    "CMOS",
    "Unknown"
  ]
}

\section enum_image_notify_payload_type ImageNotifyPayloadType Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ImageNotifyPayloadType Enum Properties",
  "type": "string",
  "enum": [
    "QueryJitter",
    "QueryJitterAndManufacturerCode",
    "QueryJitterManufacturerCodeAndImageType",
    "QueryJitterManufacturerCodeImageTypeAndNewFileVersion"
  ]
}

\section enum_logging_level_enum LoggingLevelEnum Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "LoggingLevelEnum Enum Properties",
  "type": "string",
  "enum": [
    "Debug",
    "Info",
    "Warning",
    "Error",
    "Critical"
  ]
}

\section enum_metering_energy_carrier_unit_of_measure MeteringEnergyCarrierUnitOfMeasure Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "MeteringEnergyCarrierUnitOfMeasure Enum Properties",
  "type": "string",
  "enum": [
    "KilowattHoursOrKilowatts",
    "CubicMeterOrCubicMeterPerHour",
    "CubicFeetOrCubicFeetPerHour",
    "CentumCubicFeetOrCentum",
    "USGallonsOrUSGalonsPerHour",
    "ImperialGallonsOrImperialGallonsPerhour",
    "BTUsOrBTUPerhour",
    "LitersOrLitersPerHour",
    "kPAGaugein",
    "kPAabsolute",
    "mcfCubicFeetOr mcfPerHour",
    "Unitless",
    "MegaJouleMegaJoulePerSecond"
  ]
}

\section enum_metering_metering_device_type MeteringMeteringDeviceType Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "MeteringMeteringDeviceType Enum Properties",
  "type": "string",
  "enum": [
    "ElectricMetering",
    "GasMetering",
    "WaterMetering",
    "ThermalMetering",
    "PressureMetering",
    "HeatMetering",
    "CoolingMetering",
    "MirroredGasMetering",
    "MirroredWaterMetering",
    "MirroredThermalMetering",
    "MirroredPressureMetering",
    "MirroredHeatMetering",
    "MirroredCoolingMetering"
  ]
}

\section enum_metering_supply_status MeteringSupplyStatus Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "MeteringSupplyStatus Enum Properties",
  "type": "string",
  "enum": [
    "SupplyOFF",
    "SupplyOFFOrARMED",
    "SupplyON"
  ]
}

\section enum_metering_temperature_unit_of_measure MeteringTemperatureUnitOfMeasure Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "MeteringTemperatureUnitOfMeasure Enum Properties",
  "type": "string",
  "enum": [
    "DegreesKelvin",
    "DegreesCelsius",
    "DegreesFahrenheit"
  ]
}

\section enum_metering_unitof_measure MeteringUnitofMeasure Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "MeteringUnitofMeasure Enum Properties",
  "type": "string",
  "enum": [
    "KilowattHoursOrKilowatts",
    "CubicMeterOrCubicMeterPerHour",
    "CubicFeetOrCubicFeetPerHour",
    "CentumCubicFeetOrCentum",
    "USGallonsOrUSGalonsPerHour",
    "ImperialGallonsOrImperialGallonsPerhour",
    "BTUsOrBTUPerhour",
    "LitersOrLitersPerHour",
    "kPAGaugein",
    "kPAabsolute",
    "mcfCubicFeetOr mcfPerHour",
    "Unitless",
    "MegaJouleMegaJoulePerSecond"
  ]
}

\section enum_move_step_mode MoveStepMode Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "MoveStepMode Enum Properties",
  "type": "string",
  "enum": [
    "Up",
    "Down"
  ]
}

\section enum_nm_state NM_State Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "NM_State Enum Properties",
  "type": "string",
  "enum": [
    "idle",
    "add node",
    "remove node",
    "join network",
    "leave network",
    "network repair",
    "network update",
    "reset",
    "scan mode"
  ]
}

\section enum_node_state_network_status NodeStateNetworkStatus Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "NodeStateNetworkStatus Enum Properties",
  "type": "string",
  "enum": [
    "Online functional",
    "Online interviewing",
    "Online non-functional",
    "Unavailable",
    "Offline",
    "Commisioning Started"
  ]
}

\section enum_node_state_security NodeStateSecurity Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "NodeStateSecurity Enum Properties",
  "type": "string",
  "enum": [
    "None",
    "Z-Wave S0",
    "Z-Wave S2 Unauthenticated",
    "Z-Wave S2 Authenticated",
    "Z-Wave S2 Access Control",
    "Zigbee Z3",
    "Matter"
  ]
}

\section enum_ota_device_specific_image_type OTADeviceSpecificImageType Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "OTADeviceSpecificImageType Enum Properties",
  "type": "string",
  "enum": [
    "ClientSecurityCredentials",
    "ClientConfiguration",
    "ServerLog",
    "Picture"
  ]
}

\section enum_ota_upgrade_image_upgrade_status OTAUpgradeImageUpgradeStatus Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "OTAUpgradeImageUpgradeStatus Enum Properties",
  "type": "string",
  "enum": [
    "Normal",
    "DownloadInProgress",
    "DownloadComplete",
    "WaitingToUpgrade",
    "CountDown",
    "WaitForMore",
    "WaitingToUpgradeViaExternalEvent"
  ]
}

\section enum_ota_upgrade_upgrade_activation_policy OTAUpgradeUpgradeActivationPolicy Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "OTAUpgradeUpgradeActivationPolicy Enum Properties",
  "type": "string",
  "enum": [
    "OTAServerActivationAllowed",
    "OutOfBandActivationOnly"
  ]
}

\section enum_ota_upgrade_upgrade_timeout_policy OTAUpgradeUpgradeTimeoutPolicy Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "OTAUpgradeUpgradeTimeoutPolicy Enum Properties",
  "type": "string",
  "enum": [
    "ApplyUpgradeAfterTimeout",
    "DoNotApplyUpgradeAfterTimeout"
  ]
}

\section enum_occupancy_sensing_occupancy_sensor_type OccupancySensingOccupancySensorType Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "OccupancySensingOccupancySensorType Enum Properties",
  "type": "string",
  "enum": [
    "PIR",
    "Ultrasonic",
    "PIRAndUltrasonic",
    "PhysicalContact"
  ]
}

\section enum_off_with_effect_effect_identifier OffWithEffectEffectIdentifier Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "OffWithEffectEffectIdentifier Enum Properties",
  "type": "string",
  "enum": [
    "DelayedAllOff",
    "DyingLight"
  ]
}

\section enum_on_off_start_up_on_off OnOffStartUpOnOff Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "OnOffStartUpOnOff Enum Properties",
  "type": "string",
  "enum": [
    "SetOnOffTo0",
    "SetOnOffTo1",
    "TogglePreviousOnOff",
    "SetPreviousOnOff"
  ]
}

\section enum_operating_event_notification_operation_event_code OperatingEventNotificationOperationEventCode Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "OperatingEventNotificationOperationEventCode Enum Properties",
  "type": "string",
  "enum": [
    "UnknownOrMS",
    "Lock",
    "Unlock",
    "LockFailureInvalidPINOrID",
    "LockFailureInvalidSchedule",
    "UnlockFailureInvalidPINOrID",
    "UnlockFailureInvalidSchedule",
    "OneTouchLock",
    "KeyLock",
    "KeyUnlock",
    "AutoLock",
    "ScheduleLock",
    "ScheduleUnlock",
    "ManualLock",
    "ManualUnlock",
    "NonAccessUserOperationalEvent"
  ]
}

\section enum_options_startup_mode OptionsStartupMode Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "OptionsStartupMode Enum Properties",
  "type": "string",
  "enum": [
    "RestartUsingStartupParameters",
    "RestartUsingCurrentState"
  ]
}

\section enum_profile_interval_period ProfileIntervalPeriod Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ProfileIntervalPeriod Enum Properties",
  "type": "string",
  "enum": [
    "Daily",
    "60Minutes",
    "30Minutes",
    "15Minutes",
    "10Minutes",
    "7dot5Minutes",
    "5Minutes",
    "2dot5Minutes"
  ]
}

\section enum_programming_event_notification_program_event_code ProgrammingEventNotificationProgramEventCode Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ProgrammingEventNotificationProgramEventCode Enum Properties",
  "type": "string",
  "enum": [
    "UnknownOrMS",
    "MasterCodeChanged",
    "PINCodeAdded",
    "PINCodeDeleted",
    "PINCodeChanged",
    "RFIDCodeAdded",
    "RFIDCodeDeleted"
  ]
}

\section enum_programming_event_notification_program_event_source ProgrammingEventNotificationProgramEventSource Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ProgrammingEventNotificationProgramEventSource Enum Properties",
  "type": "string",
  "enum": [
    "Keypad",
    "RF",
    "RFID",
    "Indeterminate"
  ]
}

\section enum_pump_control_mode PumpControlMode Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PumpControlMode Enum Properties",
  "type": "string",
  "enum": [
    "ConstantSpeed",
    "ConstantPressure",
    "ProportionalPressure",
    "ConstantFlow",
    "ConstantTemperature",
    "Automatic"
  ]
}

\section enum_pump_operation_mode PumpOperationMode Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PumpOperationMode Enum Properties",
  "type": "string",
  "enum": [
    "Normal",
    "Minimum",
    "Maximum",
    "Local"
  ]
}

\section enum_shdcfg_direction SHDCFGDirection Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SHDCFGDirection Enum Properties",
  "type": "string",
  "enum": [
    "Closing",
    "Opening"
  ]
}

\section enum_setpoint_raise_or_lower_mode SetpointRaiseOrLowerMode Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SetpointRaiseOrLowerMode Enum Properties",
  "type": "string",
  "enum": [
    "Heat",
    "Cool",
    "Both"
  ]
}

\section enum_shade_configuration_mode ShadeConfigurationMode Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ShadeConfigurationMode Enum Properties",
  "type": "string",
  "enum": [
    "Normal",
    "Configure"
  ]
}

\section enum_siren_configuration_strobe SirenConfigurationStrobe Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SirenConfigurationStrobe Enum Properties",
  "type": "string",
  "enum": [
    "NoStrobe",
    "UseStrobe"
  ]
}

\section enum_siren_configuration_warning_mode SirenConfigurationWarningMode Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SirenConfigurationWarningMode Enum Properties",
  "type": "string",
  "enum": [
    "Stop",
    "Burgler",
    "Fire",
    "Emergency",
    "PolicePanic",
    "FirePanic",
    "EmergencyPanic"
  ]
}

\section enum_squawk_configuration_squawk_mode SquawkConfigurationSquawkMode Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SquawkConfigurationSquawkMode Enum Properties",
  "type": "string",
  "enum": [
    "SoundForSystemIsArmed",
    "SoundForSystemIsDisarmed"
  ]
}

\section enum_thermostat_ac_capacity_format ThermostatACCapacityFormat Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ThermostatACCapacityFormat Enum Properties",
  "type": "string",
  "enum": [
    "BTUh"
  ]
}

\section enum_thermostat_ac_compressor_type ThermostatACCompressorType Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ThermostatACCompressorType Enum Properties",
  "type": "string",
  "enum": [
    "T1",
    "T2",
    "T3"
  ]
}

\section enum_thermostat_ac_louver_position ThermostatACLouverPosition Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ThermostatACLouverPosition Enum Properties",
  "type": "string",
  "enum": [
    "FullyClosed",
    "FullyOpen",
    "QuarterOpen",
    "HalfOpen",
    "ThreeQuartersOpen"
  ]
}

\section enum_thermostat_ac_refrigerant_type ThermostatACRefrigerantType Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ThermostatACRefrigerantType Enum Properties",
  "type": "string",
  "enum": [
    "R22",
    "R410a",
    "R407c"
  ]
}

\section enum_thermostat_ac_type ThermostatACType Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ThermostatACType Enum Properties",
  "type": "string",
  "enum": [
    "CoolingAndFixedSpeed",
    "HeatPumpAndFixedSpeed",
    "CoolingAndInverter",
    "HeatPumpAndInverter"
  ]
}

\section enum_thermostat_control_sequence_of_operation ThermostatControlSequenceOfOperation Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ThermostatControlSequenceOfOperation Enum Properties",
  "type": "string",
  "enum": [
    "CoolingOnly",
    "CoolingWithReheat",
    "HeatingOnly",
    "HeatingWithReheat",
    "CoolingAndHeating4Pipes",
    "CoolingAndHeating4PipesWithReheat"
  ]
}

\section enum_thermostat_programming_operation_mode_programming_mode ThermostatProgrammingOperationModeProgrammingMode Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ThermostatProgrammingOperationModeProgrammingMode Enum Properties",
  "type": "string",
  "enum": [
    "SimpleOrSetpoint",
    "Schedule"
  ]
}

\section enum_thermostat_setpoint_change_source ThermostatSetpointChangeSource Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ThermostatSetpointChangeSource Enum Properties",
  "type": "string",
  "enum": [
    "Manual",
    "ScheduleOrInternalProgramming",
    "External"
  ]
}

\section enum_thermostat_start_of_week ThermostatStartOfWeek Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ThermostatStartOfWeek Enum Properties",
  "type": "string",
  "enum": [
    "Sunday",
    "Monday",
    "Tuesday",
    "Wednesday",
    "Thursday",
    "Friday",
    "Saturday"
  ]
}

\section enum_thermostat_system_mode ThermostatSystemMode Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ThermostatSystemMode Enum Properties",
  "type": "string",
  "enum": [
    "Off",
    "Auto",
    "Cool",
    "Heat",
    "EmergencyHeating",
    "Precooling",
    "FanOnly",
    "Dry",
    "Sleep"
  ]
}

\section enum_thermostat_temperature_setpoint_hold ThermostatTemperatureSetpointHold Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ThermostatTemperatureSetpointHold Enum Properties",
  "type": "string",
  "enum": [
    "SetpointHoldOff",
    "SetpointHoldOn"
  ]
}

\section enum_thermostat_thermostat_running_mode ThermostatThermostatRunningMode Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ThermostatThermostatRunningMode Enum Properties",
  "type": "string",
  "enum": [
    "Off",
    "Cool",
    "Heat"
  ]
}

\section enum_thermostat_user_interface_configuration_keypad_lockout ThermostatUserInterfaceConfigurationKeypadLockout Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ThermostatUserInterfaceConfigurationKeypadLockout Enum Properties",
  "type": "string",
  "enum": [
    "None",
    "Level1",
    "Level2",
    "Level3",
    "Level4",
    "Level5"
  ]
}

\section enum_thermostat_user_interface_configuration_schedule_programming_visibility ThermostatUserInterfaceConfigurationScheduleProgrammingVisibility Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ThermostatUserInterfaceConfigurationScheduleProgrammingVisibility Enum Properties",
  "type": "string",
  "enum": [
    "LocalEnabled",
    "LocalDisabled"
  ]
}

\section enum_thermostat_user_interface_configuration_temperature_display_mode ThermostatUserInterfaceConfigurationTemperatureDisplayMode Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ThermostatUserInterfaceConfigurationTemperatureDisplayMode Enum Properties",
  "type": "string",
  "enum": [
    "Celsius",
    "Fahrenheit"
  ]
}

\section enum_trigger_effect_effect_identifier TriggerEffectEffectIdentifier Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "TriggerEffectEffectIdentifier Enum Properties",
  "type": "string",
  "enum": [
    "Blink",
    "Breathe",
    "Okay",
    "ChannelChange",
    "FinishEffect",
    "StopEffect"
  ]
}

\section enum_trigger_effect_effect_variant TriggerEffectEffectVariant Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "TriggerEffectEffectVariant Enum Properties",
  "type": "string",
  "enum": [
    "Default"
  ]
}

\section enum_tx_report_transmission_speed TxReportTransmissionSpeed Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "TxReportTransmissionSpeed Enum Properties",
  "type": "string",
  "enum": [
    "Z-Wave-9600-bits-per-second",
    "Z-Wave-40-kbits-per-second",
    "Z-Wave-100-kbits-per-second",
    "Z-WaveLongRange-100-kbits-per-second",
    "Other",
    "Unknown"
  ]
}

\section enum_window_covering_window_covering_type WindowCoveringWindowCoveringType Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindowCoveringWindowCoveringType Enum Properties",
  "type": "string",
  "enum": [
    "Rollershade",
    "Rollershade2Motor",
    "RollershadeExterior",
    "RollershadeExterior2Motor",
    "Drapery",
    "Awning",
    "Shutter",
    "TiltBlindTiltOnly",
    "TiltBlindLiftAndTilt",
    "ProjectorScreen"
  ]
}

\section enum_zone_enroll_response_enroll_response_code ZoneEnrollResponseEnrollResponseCode Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ZoneEnrollResponseEnrollResponseCode Enum Properties",
  "type": "string",
  "enum": [
    "Success",
    "NotSupported",
    "NoEnrollPermit",
    "TooManyZones"
  ]
}

\section enum_attribute_reporting_status attributeReportingStatus Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "attributeReportingStatus Enum Properties",
  "type": "string",
  "enum": [
    "Pending",
    "Complete"
  ]
}

\section enum_zcl_status zclStatus Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "zclStatus Enum Properties",
  "type": "string",
  "enum": [
    "SUCCESS",
    "FAILURE",
    "NOT_AUTHORIZED",
    "MALFORMED_COMMAND",
    "UNSUP_CLUSTER_COMMAND",
    "UNSUP_GENERAL_COMMAND",
    "UNSUP_MANUF_CLUSTER_COMMAND",
    "UNSUP_MANUF_GENERAL_COMMAND",
    "INVALID_FIELD",
    "UNSUPPORTED_ATTRIBUTE",
    "INVALID_VALUE",
    "READ_ONLY",
    "INSUFFICIENT_SPACE",
    "DUPLICATE_EXISTS",
    "NOT_FOUND",
    "UNREPORTABLE_ATTRIBUTE",
    "INVALID_DATA_TYPE",
    "INVALID_SELECTOR",
    "WRITE_ONLY",
    "INCONSISTENT_STARTUP_STATE",
    "DEFINED_OUT_OF_BAND",
    "INCONSISTENT",
    "ACTION_DENIED",
    "TIMEOUT",
    "ABORT",
    "INVALID_IMAGE",
    "WAIT_FOR_DATA",
    "NO_IMAGE_AVAILABLE",
    "REQUIRE_MORE_IMAGE",
    "NOTIFICATION_PENDING",
    "HARDWARE_FAILURE",
    "SOFTWARE_FAILURE",
    "CALIBRATION_ERROR",
    "UNSUPPORTED_CLUSTER",
    "LIMIT_REACHED"
  ]
}

\section enum_zcl_type zclType Enum

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "zclType Enum Properties",
  "type": "string",
  "enum": [
    "nodata",
    "data8",
    "data16",
    "data24",
    "data32",
    "data40",
    "data48",
    "data56",
    "data64",
    "bool",
    "map8",
    "map16",
    "map24",
    "map32",
    "map40",
    "map48",
    "map56",
    "map64",
    "uint8",
    "uint16",
    "uint24",
    "uint32",
    "uint40",
    "uint48",
    "uint56",
    "uint64",
    "int8",
    "int16",
    "int24",
    "int32",
    "int40",
    "int48",
    "int56",
    "int64",
    "enum8",
    "enum16",
    "semi",
    "single",
    "double",
    "octstr",
    "string",
    "octstr16",
    "string16",
    "array",
    "struct",
    "set",
    "bag",
    "fabric_idx",
    "ToD",
    "date",
    "UTC",
    "clusterId",
    "attribId",
    "bacOID",
    "EUI64",
    "key128",
    "unk"
  ]
}

\page ucl_bitmaps UCL Bitmaps

NOTE: Not all enum types are used

\section enum_ballast_configuration_ballast_status BallastConfigurationBallastStatus Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BallastConfigurationBallastStatus Enum Properties",
  "type": "object",
  "properties": {
    "BallastNonOperational": {
        "type": "boolean"
    },
    "LampFailure": {
        "type": "boolean"
    }
  }
}

\section enum_ballast_configuration_lamp_alarm_mode BallastConfigurationLampAlarmMode Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BallastConfigurationLampAlarmMode Enum Properties",
  "type": "object",
  "properties": {
    "LampBurnHours": {
        "type": "boolean"
    }
  }
}

\section enum_barrier_control_capabilities BarrierControlCapabilities Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BarrierControlCapabilities Enum Properties",
  "type": "object",
  "properties": {
    "PartialBarrier": {
        "type": "boolean"
    }
  }
}

\section enum_barrier_control_safety_status BarrierControlSafetyStatus Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BarrierControlSafetyStatus Enum Properties",
  "type": "object",
  "properties": {
    "RemoteLockout": {
        "type": "boolean"
    },
    "TamperDetected": {
        "type": "boolean"
    },
    "FailedCommunication": {
        "type": "boolean"
    },
    "PositionFailure": {
        "type": "boolean"
    }
  }
}

\section enum_basic_alarm_mask BasicAlarmMask Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BasicAlarmMask Enum Properties",
  "type": "object",
  "properties": {
    "GeneralHardwareFault": {
        "type": "boolean"
    },
    "GeneralSoftwareFault": {
        "type": "boolean"
    }
  }
}

\section enum_basic_disable_local_config BasicDisableLocalConfig Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BasicDisableLocalConfig Enum Properties",
  "type": "object",
  "properties": {
    "DisableResetToFactoryDefaults": {
        "type": "boolean"
    },
    "DisableDeviceConfiguration": {
        "type": "boolean"
    }
  }
}

\section enum_battery_alarm_mask BatteryAlarmMask Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BatteryAlarmMask Enum Properties",
  "type": "object",
  "properties": {
    "BatteryVoltageTooLow": {
        "type": "boolean"
    },
    "BatteryAlarm1": {
        "type": "boolean"
    },
    "BatteryAlarm2": {
        "type": "boolean"
    },
    "BatteryAlarm3": {
        "type": "boolean"
    }
  }
}

\section enum_battery_alarm_state BatteryAlarmState Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BatteryAlarmState Enum Properties",
  "type": "object",
  "properties": {
    "Battery1MinThreshold": {
        "type": "boolean"
    },
    "Battery1Threshold1": {
        "type": "boolean"
    },
    "Battery1Threshold2": {
        "type": "boolean"
    },
    "Battery1Threshold3": {
        "type": "boolean"
    },
    "Battery2MinThreshold": {
        "type": "boolean"
    },
    "Battery2Threshold1": {
        "type": "boolean"
    },
    "Battery2Threshold2": {
        "type": "boolean"
    },
    "Battery2Threshold3": {
        "type": "boolean"
    },
    "Battery3MinThreshold": {
        "type": "boolean"
    },
    "Battery3Threshold1": {
        "type": "boolean"
    },
    "Battery3Threshold2": {
        "type": "boolean"
    },
    "Battery3Threshold3": {
        "type": "boolean"
    },
    "MainsPowerSupplyLost": {
        "type": "boolean"
    }
  }
}

\section enum_cc_color_options CCColorOptions Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CCColorOptions Enum Properties",
  "type": "object",
  "properties": {
    "ExecuteIfOff": {
        "type": "boolean"
    }
  }
}

\section enum_color_control_color_capabilities ColorControlColorCapabilities Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControlColorCapabilities Enum Properties",
  "type": "object",
  "properties": {
    "HueSaturationSupported": {
        "type": "boolean"
    },
    "EnhancedHueSupported": {
        "type": "boolean"
    },
    "ColorLoopSupported": {
        "type": "boolean"
    },
    "XYSupported": {
        "type": "boolean"
    },
    "ColorTemperatureSupported": {
        "type": "boolean"
    }
  }
}

\section enum_color_loop_set_update_flags ColorLoopSetUpdateFlags Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorLoopSetUpdateFlags Enum Properties",
  "type": "object",
  "properties": {
    "UpdateAction": {
        "type": "boolean"
    },
    "UpdateDirection": {
        "type": "boolean"
    },
    "UpdateTime": {
        "type": "boolean"
    },
    "UpdateStartHue": {
        "type": "boolean"
    }
  }
}

\section enum_copy_scene_mode CopySceneMode Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CopySceneMode Enum Properties",
  "type": "object",
  "properties": {
    "CopyAllScenes": {
        "type": "boolean"
    }
  }
}

\section enum_device_temperature_configuration_device_temp_alarm_mask DeviceTemperatureConfigurationDeviceTempAlarmMask Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DeviceTemperatureConfigurationDeviceTempAlarmMask Enum Properties",
  "type": "object",
  "properties": {
    "DeviceTemperatureTooLow": {
        "type": "boolean"
    },
    "DeviceTemperatureTooHigh": {
        "type": "boolean"
    }
  }
}

\section enum_door_lock_alarm_mask DoorLockAlarmMask Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLockAlarmMask Enum Properties",
  "type": "object",
  "properties": {
    "DeadboltJammed": {
        "type": "boolean"
    },
    "LockResetToFactoryDefaults": {
        "type": "boolean"
    },
    "RFPowerModuleCycled": {
        "type": "boolean"
    },
    "TamperAlarmWrongCodeEntryLimit": {
        "type": "boolean"
    },
    "TamperAlarmFrontEscutcheonRemovedFromMain": {
        "type": "boolean"
    },
    "ForcedDoorOpenUnderDoorLockedCondition": {
        "type": "boolean"
    }
  }
}

\section enum_door_lock_credential_rules_support DoorLockCredentialRulesSupport Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLockCredentialRulesSupport Enum Properties",
  "type": "object",
  "properties": {
    "Single": {
        "type": "boolean"
    },
    "Dual": {
        "type": "boolean"
    },
    "Tri": {
        "type": "boolean"
    }
  }
}

\section enum_door_lock_default_configuration_register DoorLockDefaultConfigurationRegister Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLockDefaultConfigurationRegister Enum Properties",
  "type": "object",
  "properties": {
    "DefaultEnableLocalProgrammingAttributeIsEnabled": {
        "type": "boolean"
    },
    "DefaultKeypadInterfaceIsEnabled": {
        "type": "boolean"
    },
    "DefaultRFInterfaceIsEnabled": {
        "type": "boolean"
    },
    "DefaultSoundVolumeIsEnabled": {
        "type": "boolean"
    },
    "DefaultAutoRelockTimeIsEnabled": {
        "type": "boolean"
    },
    "DefaultLEDSettingsIsEnabled": {
        "type": "boolean"
    }
  }
}

\section enum_door_lock_feature_map DoorLockFeatureMap Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLockFeatureMap Enum Properties",
  "type": "object",
  "properties": {
    "PINCredential": {
        "type": "boolean"
    },
    "RFIDCredential": {
        "type": "boolean"
    },
    "FingerCredentials": {
        "type": "boolean"
    },
    "Logging": {
        "type": "boolean"
    },
    "WeekDayAccessSchedules": {
        "type": "boolean"
    },
    "DoorPositionSensor": {
        "type": "boolean"
    },
    "FaceCredentials": {
        "type": "boolean"
    },
    "CredentialOverTheAirAccess": {
        "type": "boolean"
    },
    "User": {
        "type": "boolean"
    },
    "Notification": {
        "type": "boolean"
    },
    "YearDayAccessSchedules": {
        "type": "boolean"
    },
    "HolidaySchedules": {
        "type": "boolean"
    },
    "Unbolting": {
        "type": "boolean"
    }
  }
}

\section enum_door_lock_keypad_operation_event_mask DoorLockKeypadOperationEventMask Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLockKeypadOperationEventMask Enum Properties",
  "type": "object",
  "properties": {
    "KeypadOpUnknownOrMS": {
        "type": "boolean"
    },
    "KeypadOpLock": {
        "type": "boolean"
    },
    "KeypadOpUnlock": {
        "type": "boolean"
    },
    "KeypadOpLockErrorInvalidPIN": {
        "type": "boolean"
    },
    "KeypadOpLockErrorInvalidSchedule": {
        "type": "boolean"
    },
    "KeypadOpUnlockInvalidPIN": {
        "type": "boolean"
    },
    "KeypadOpUnlockInvalidSchedule": {
        "type": "boolean"
    },
    "KeypadOpNonAccessUser": {
        "type": "boolean"
    }
  }
}

\section enum_door_lock_keypad_programming_event_mask DoorLockKeypadProgrammingEventMask Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLockKeypadProgrammingEventMask Enum Properties",
  "type": "object",
  "properties": {
    "KeypadProgUnknownOrMS": {
        "type": "boolean"
    },
    "KeypadProgMasterCodeChanged": {
        "type": "boolean"
    },
    "KeypadProgPINAdded": {
        "type": "boolean"
    },
    "KeypadProgPINDeleted": {
        "type": "boolean"
    },
    "KeypadProgPINChanged": {
        "type": "boolean"
    }
  }
}

\section enum_door_lock_local_programming_features DoorLockLocalProgrammingFeatures Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLockLocalProgrammingFeatures Enum Properties",
  "type": "object",
  "properties": {
    "AddUsersCredentialsSchedulesLocally": {
        "type": "boolean"
    },
    "ModifyUsersCredentialsSchedulesLocally": {
        "type": "boolean"
    },
    "ClearUsersCredentialsSchedulesLocally": {
        "type": "boolean"
    },
    "AdjustLockSettingsLocally": {
        "type": "boolean"
    }
  }
}

\section enum_door_lock_manual_operation_event_mask DoorLockManualOperationEventMask Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLockManualOperationEventMask Enum Properties",
  "type": "object",
  "properties": {
    "ManualOpUnknownOrMS": {
        "type": "boolean"
    },
    "ManualOpThumbturnLock": {
        "type": "boolean"
    },
    "ManualOpThumbturnUnlock": {
        "type": "boolean"
    },
    "ManualOpOneTouchLock": {
        "type": "boolean"
    },
    "ManualOpKeyLock": {
        "type": "boolean"
    },
    "ManualOpKeyUnlock": {
        "type": "boolean"
    },
    "ManualOpAutoLock": {
        "type": "boolean"
    },
    "ManualOpScheduleLock": {
        "type": "boolean"
    },
    "ManualOpScheduleUnlock": {
        "type": "boolean"
    },
    "ManualOpLock": {
        "type": "boolean"
    },
    "ManualOpUnlock": {
        "type": "boolean"
    }
  }
}

\section enum_door_lock_rfid_operation_event_mask DoorLockRFIDOperationEventMask Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLockRFIDOperationEventMask Enum Properties",
  "type": "object",
  "properties": {
    "RFIDOpUnknownOrMS": {
        "type": "boolean"
    },
    "RFIDOpLock": {
        "type": "boolean"
    },
    "RFIDOpUnlock": {
        "type": "boolean"
    },
    "RFIDOpLockErrorInvalidRFID": {
        "type": "boolean"
    },
    "RFIDOpLockErrorInvalidSchedule": {
        "type": "boolean"
    },
    "RFIDOpUnlockErrorInvalidRFID": {
        "type": "boolean"
    },
    "RFIDOpUnlockErrorInvalidSchedule": {
        "type": "boolean"
    }
  }
}

\section enum_door_lock_rfid_programming_event_mask DoorLockRFIDProgrammingEventMask Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLockRFIDProgrammingEventMask Enum Properties",
  "type": "object",
  "properties": {
    "RFIDProgUnknownOrMS": {
        "type": "boolean"
    },
    "RFIDProgRFIDAdded": {
        "type": "boolean"
    },
    "RFIDProgRFIDDeleted": {
        "type": "boolean"
    }
  }
}

\section enum_door_lock_rf_operation_event_mask DoorLockRFOperationEventMask Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLockRFOperationEventMask Enum Properties",
  "type": "object",
  "properties": {
    "RFOpUnknownOrMS": {
        "type": "boolean"
    },
    "RFOpLock": {
        "type": "boolean"
    },
    "RFOpUnlock": {
        "type": "boolean"
    },
    "RFOpLockErrorInvalidCode": {
        "type": "boolean"
    },
    "RFOpLockErrorInvalidSchedule": {
        "type": "boolean"
    },
    "RFOpUnlockInvalidCode": {
        "type": "boolean"
    },
    "RFOpUnlockInvalidSchedule": {
        "type": "boolean"
    }
  }
}

\section enum_door_lock_rf_programming_event_mask DoorLockRFProgrammingEventMask Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLockRFProgrammingEventMask Enum Properties",
  "type": "object",
  "properties": {
    "RFProgUnknownOrMS": {
        "type": "boolean"
    },
    "RFProgPINAdded": {
        "type": "boolean"
    },
    "RFProgPINDeleted": {
        "type": "boolean"
    },
    "RFProgPINChanged": {
        "type": "boolean"
    },
    "RFProgRFIDAdded": {
        "type": "boolean"
    },
    "RFProgRFIDDeleted": {
        "type": "boolean"
    }
  }
}

\section enum_door_lock_supported_operating_modes DoorLockSupportedOperatingModes Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLockSupportedOperatingModes Enum Properties",
  "type": "object",
  "properties": {
    "NormalModeSupported": {
        "type": "boolean"
    },
    "VacationModeSupported": {
        "type": "boolean"
    },
    "PrivacyModeSupported": {
        "type": "boolean"
    },
    "NoRFLockOrUnlockModeSupported": {
        "type": "boolean"
    },
    "PassageModeSupported": {
        "type": "boolean"
    }
  }
}

\section enum_drlk_days_mask DrlkDaysMask Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DrlkDaysMask Enum Properties",
  "type": "object",
  "properties": {
    "Sun": {
        "type": "boolean"
    },
    "Mon": {
        "type": "boolean"
    },
    "Tue": {
        "type": "boolean"
    },
    "Wed": {
        "type": "boolean"
    },
    "Thu": {
        "type": "boolean"
    },
    "Fri": {
        "type": "boolean"
    },
    "Sat": {
        "type": "boolean"
    },
    "Enable": {
        "type": "boolean"
    }
  }
}

\section enum_electrical_measurement_ac_alarms_mask ElectricalMeasurementACAlarmsMask Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurementACAlarmsMask Enum Properties",
  "type": "object",
  "properties": {
    "VoltageOverload": {
        "type": "boolean"
    },
    "CurrentOverload": {
        "type": "boolean"
    },
    "ActivePowerOverload": {
        "type": "boolean"
    },
    "ReactivePowerOverload": {
        "type": "boolean"
    },
    "AverageRMSOverVoltage": {
        "type": "boolean"
    },
    "AverageRMSUnderVoltage": {
        "type": "boolean"
    },
    "RMSExtremeOverVoltage": {
        "type": "boolean"
    },
    "RMSExtremeUnderVoltage": {
        "type": "boolean"
    },
    "RMSVoltageSag": {
        "type": "boolean"
    },
    "RMSVoltageSwell": {
        "type": "boolean"
    }
  }
}

\section enum_electrical_measurement_dc_overload_alarms_mask ElectricalMeasurementDCOverloadAlarmsMask Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurementDCOverloadAlarmsMask Enum Properties",
  "type": "object",
  "properties": {
    "VoltageOverload": {
        "type": "boolean"
    },
    "CurrentOverload": {
        "type": "boolean"
    }
  }
}

\section enum_electrical_measurement_measurement_type ElectricalMeasurementMeasurementType Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElectricalMeasurementMeasurementType Enum Properties",
  "type": "object",
  "properties": {
    "ActiveMeasurementAC": {
        "type": "boolean"
    },
    "ReactiveMeasurementAC": {
        "type": "boolean"
    },
    "ApparentMeasurementAC": {
        "type": "boolean"
    },
    "PhaseAMeasurement": {
        "type": "boolean"
    },
    "PhaseBMeasurement": {
        "type": "boolean"
    },
    "PhaseCMeasurement": {
        "type": "boolean"
    },
    "DCMeasurement": {
        "type": "boolean"
    },
    "HarmonicsMeasurement": {
        "type": "boolean"
    },
    "PowerQualityMeasurement": {
        "type": "boolean"
    }
  }
}

\section enum_groups_name_support GroupsNameSupport Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "GroupsNameSupport Enum Properties",
  "type": "object",
  "properties": {
    "Supported": {
        "type": "boolean"
    }
  }
}

\section enum_ias_zone_status IasZoneStatus Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IasZoneStatus Enum Properties",
  "type": "object",
  "properties": {
    "Alarm1": {
        "type": "boolean"
    },
    "Alarm2": {
        "type": "boolean"
    },
    "Tamper": {
        "type": "boolean"
    },
    "BatteryLow": {
        "type": "boolean"
    },
    "SupervisionNotify": {
        "type": "boolean"
    },
    "RestoreNotify": {
        "type": "boolean"
    },
    "Trouble": {
        "type": "boolean"
    },
    "ACMainsFault": {
        "type": "boolean"
    },
    "Test": {
        "type": "boolean"
    },
    "BatteryDefect": {
        "type": "boolean"
    }
  }
}

\section enum_image_block_request_field_control ImageBlockRequestFieldControl Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ImageBlockRequestFieldControl Enum Properties",
  "type": "object",
  "properties": {
    "RequestNodeIEEEAddressPresent": {
        "type": "boolean"
    },
    "MinimumBlockPeriodPresent": {
        "type": "boolean"
    }
  }
}

\section enum_image_page_request_field_control ImagePageRequestFieldControl Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ImagePageRequestFieldControl Enum Properties",
  "type": "object",
  "properties": {
    "RequestNodeIEEEAddressPresent": {
        "type": "boolean"
    }
  }
}

\section enum_level_options LevelOptions Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "LevelOptions Enum Properties",
  "type": "object",
  "properties": {
    "ExecuteIfOff": {
        "type": "boolean"
    },
    "CoupleColorTempToLevel": {
        "type": "boolean"
    }
  }
}

\section enum_metering_demand_formatting MeteringDemandFormatting Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "MeteringDemandFormatting Enum Properties",
  "type": "object",
  "properties": {
    "SuppressLeadingZeros": {
        "type": "boolean"
    },
    "NumberOfDigitsToTheRightOfDecimalPoint": {
        "type": "boolean"
    },
    "NumberOfDigitsToTheLeftOfTheDecimalPoint": {
        "type": "boolean"
    }
  }
}

\section enum_metering_energy_carrier_demand_formatting MeteringEnergyCarrierDemandFormatting Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "MeteringEnergyCarrierDemandFormatting Enum Properties",
  "type": "object",
  "properties": {
    "SuppressLeadingZeros": {
        "type": "boolean"
    },
    "NumberOfDigitsToTheRightOfDecimalPoint": {
        "type": "boolean"
    },
    "NumberOfDigitsToTheLeftOfTheDecimalPoint": {
        "type": "boolean"
    }
  }
}

\section enum_metering_energy_carrier_summation_formatting MeteringEnergyCarrierSummationFormatting Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "MeteringEnergyCarrierSummationFormatting Enum Properties",
  "type": "object",
  "properties": {
    "SuppressLeadingZeros": {
        "type": "boolean"
    },
    "NumberOfDigitsToTheRightOfDecimalPoint": {
        "type": "boolean"
    },
    "NumberOfDigitsToTheLeftOfTheDecimalPoint": {
        "type": "boolean"
    }
  }
}

\section enum_metering_historical_consumption_formatting MeteringHistoricalConsumptionFormatting Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "MeteringHistoricalConsumptionFormatting Enum Properties",
  "type": "object",
  "properties": {
    "SuppressLeadingZeros": {
        "type": "boolean"
    },
    "NumberOfDigitsToTheRightOfDecimalPoint": {
        "type": "boolean"
    },
    "NumberOfDigitsToTheLeftOfTheDecimalPoint": {
        "type": "boolean"
    }
  }
}

\section enum_metering_summation_formatting MeteringSummationFormatting Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "MeteringSummationFormatting Enum Properties",
  "type": "object",
  "properties": {
    "SuppressLeadingZeros": {
        "type": "boolean"
    },
    "NumberOfDigitsToTheRightOfDecimalPoint": {
        "type": "boolean"
    },
    "NumberOfDigitsToTheLeftOfTheDecimalPoint": {
        "type": "boolean"
    }
  }
}

\section enum_metering_temperature_formatting MeteringTemperatureFormatting Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "MeteringTemperatureFormatting Enum Properties",
  "type": "object",
  "properties": {
    "SuppressLeadingZeros": {
        "type": "boolean"
    },
    "NumberOfDigitsToTheRightOfDecimalPoint": {
        "type": "boolean"
    },
    "NumberOfDigitsToTheLeftOfTheDecimalPoint": {
        "type": "boolean"
    }
  }
}

\section enum_occupancy_sensing_occupancy OccupancySensingOccupancy Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "OccupancySensingOccupancy Enum Properties",
  "type": "object",
  "properties": {
    "SensedOccupancy": {
        "type": "boolean"
    }
  }
}

\section enum_occupancy_sensing_occupancy_sensor_type_bitmap OccupancySensingOccupancySensorTypeBitmap Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "OccupancySensingOccupancySensorTypeBitmap Enum Properties",
  "type": "object",
  "properties": {
    "PIR": {
        "type": "boolean"
    },
    "Ultrasonic": {
        "type": "boolean"
    },
    "PhysicalContact": {
        "type": "boolean"
    }
  }
}

\section enum_on_with_timed_off_on_off_control OnWithTimedOffOnOffControl Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "OnWithTimedOffOnOffControl Enum Properties",
  "type": "object",
  "properties": {
    "AcceptOnlyWhenOn": {
        "type": "boolean"
    }
  }
}

\section enum_power_configuration_mains_alarm_mask PowerConfigurationMainsAlarmMask Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PowerConfigurationMainsAlarmMask Enum Properties",
  "type": "object",
  "properties": {
    "MainsVoltageTooLow": {
        "type": "boolean"
    },
    "MainsVoltageTooHigh": {
        "type": "boolean"
    },
    "MainsPowerSupplyLost": {
        "type": "boolean"
    }
  }
}

\section enum_pump_configuration_and_control_alarm_mask PumpConfigurationAndControlAlarmMask Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PumpConfigurationAndControlAlarmMask Enum Properties",
  "type": "object",
  "properties": {
    "SupplyVoltageTooLow": {
        "type": "boolean"
    },
    "SupplyVoltageTooHigh": {
        "type": "boolean"
    },
    "PowerMissingPhase": {
        "type": "boolean"
    },
    "SystemPressureTooLow": {
        "type": "boolean"
    },
    "SystemPressureTooHigh": {
        "type": "boolean"
    },
    "DryRunning": {
        "type": "boolean"
    },
    "MotorTemperatureTooHigh": {
        "type": "boolean"
    },
    "PumpMotorHasFatalFailure": {
        "type": "boolean"
    },
    "ElectronicTemperatureTooHigh": {
        "type": "boolean"
    },
    "PumpBlocked": {
        "type": "boolean"
    },
    "SensorFailure": {
        "type": "boolean"
    },
    "ElectronicNonFatalFailure": {
        "type": "boolean"
    },
    "ElectronicFatalFailure": {
        "type": "boolean"
    },
    "GeneralFault": {
        "type": "boolean"
    }
  }
}

\section enum_pump_configuration_and_control_pump_status PumpConfigurationAndControlPumpStatus Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PumpConfigurationAndControlPumpStatus Enum Properties",
  "type": "object",
  "properties": {
    "DeviceFault": {
        "type": "boolean"
    },
    "SupplyFault": {
        "type": "boolean"
    },
    "SpeedLow": {
        "type": "boolean"
    },
    "SpeedHigh": {
        "type": "boolean"
    },
    "LocalOverride": {
        "type": "boolean"
    },
    "Running": {
        "type": "boolean"
    },
    "RemotePressure": {
        "type": "boolean"
    },
    "RemoteFlow": {
        "type": "boolean"
    },
    "RemoteTemperature": {
        "type": "boolean"
    }
  }
}

\section enum_query_next_image_request_field_control QueryNextImageRequestFieldControl Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "QueryNextImageRequestFieldControl Enum Properties",
  "type": "object",
  "properties": {
    "HardwareVersionPresent": {
        "type": "boolean"
    }
  }
}

\section enum_reset_startup_parameters_options ResetStartupParametersOptions Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ResetStartupParametersOptions Enum Properties",
  "type": "object",
  "properties": {
    "ResetCurrent": {
        "type": "boolean"
    },
    "ResetAll": {
        "type": "boolean"
    },
    "EraseIndex": {
        "type": "boolean"
    }
  }
}

\section enum_restart_device_options RestartDeviceOptions Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "RestartDeviceOptions Enum Properties",
  "type": "object",
  "properties": {
    "StartupMode": {
        "type": "boolean"
    },
    "Immediate": {
        "type": "boolean"
    }
  }
}

\section enum_scenes_name_support ScenesNameSupport Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ScenesNameSupport Enum Properties",
  "type": "object",
  "properties": {
    "SceneNamesSupported": {
        "type": "boolean"
    }
  }
}

\section enum_shade_configuration_status ShadeConfigurationStatus Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ShadeConfigurationStatus Enum Properties",
  "type": "object",
  "properties": {
    "ShadeOperational": {
        "type": "boolean"
    },
    "ShadeAdjusting": {
        "type": "boolean"
    },
    "ShadeDirection": {
        "type": "boolean"
    },
    "ForwardDirectionOfMotor": {
        "type": "boolean"
    }
  }
}

\section enum_squawk_squawk_configuration SquawkSquawkConfiguration Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SquawkSquawkConfiguration Enum Properties",
  "type": "object",
  "properties": {
    "SquawkLevel": {
        "type": "boolean"
    },
    "SquawkStrobeActive": {
        "type": "boolean"
    },
    "SquawkMode": {
        "type": "boolean"
    }
  }
}

\section enum_start_warning_siren_configuration StartWarningSirenConfiguration Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "StartWarningSirenConfiguration Enum Properties",
  "type": "object",
  "properties": {
    "SirenLevel": {
        "type": "boolean"
    },
    "Strobe": {
        "type": "boolean"
    },
    "WarningMode": {
        "type": "boolean"
    }
  }
}

\section enum_thermostat_ac_error_code ThermostatACErrorCode Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ThermostatACErrorCode Enum Properties",
  "type": "object",
  "properties": {
    "CompressorFailureOrRefrigerantLeakage": {
        "type": "boolean"
    },
    "RoomTemperatureSensorFailure": {
        "type": "boolean"
    },
    "OutdoorTemperatureSensorFailure": {
        "type": "boolean"
    },
    "IndoorCoilTemperatureSensorFailure": {
        "type": "boolean"
    },
    "FanFailure": {
        "type": "boolean"
    }
  }
}

\section enum_thermostat_alarm_mask ThermostatAlarmMask Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ThermostatAlarmMask Enum Properties",
  "type": "object",
  "properties": {
    "InitializationFailure": {
        "type": "boolean"
    },
    "HardwareFailure": {
        "type": "boolean"
    },
    "SelfCalibrationFailure": {
        "type": "boolean"
    }
  }
}

\section enum_thermostat_hvac_system_type_configuration ThermostatHVACSystemTypeConfiguration Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ThermostatHVACSystemTypeConfiguration Enum Properties",
  "type": "object",
  "properties": {
    "CoolingSystemStage": {
        "type": "boolean"
    },
    "HeatingSystemStage": {
        "type": "boolean"
    },
    "HeatingSystemType": {
        "type": "boolean"
    },
    "HeatingFuelSource": {
        "type": "boolean"
    }
  }
}

\section enum_thermostat_occupancy ThermostatOccupancy Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ThermostatOccupancy Enum Properties",
  "type": "object",
  "properties": {
    "Occupied": {
        "type": "boolean"
    }
  }
}

\section enum_thermostat_remote_sensing ThermostatRemoteSensing Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ThermostatRemoteSensing Enum Properties",
  "type": "object",
  "properties": {
    "LocalTemperatureRemote": {
        "type": "boolean"
    },
    "OutdoorTemperatureRemote": {
        "type": "boolean"
    },
    "OccupancyRemote": {
        "type": "boolean"
    }
  }
}

\section enum_thermostat_thermostat_programming_operation_mode ThermostatThermostatProgrammingOperationMode Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ThermostatThermostatProgrammingOperationMode Enum Properties",
  "type": "object",
  "properties": {
    "ProgrammingMode": {
        "type": "boolean"
    },
    "AutoOrRecovery": {
        "type": "boolean"
    },
    "EconomyOrEnergyStar": {
        "type": "boolean"
    }
  }
}

\section enum_thermostat_thermostat_running_state ThermostatThermostatRunningState Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ThermostatThermostatRunningState Enum Properties",
  "type": "object",
  "properties": {
    "HeatOn": {
        "type": "boolean"
    },
    "CoolOn": {
        "type": "boolean"
    },
    "FanOn": {
        "type": "boolean"
    },
    "HeatSecondStageOn": {
        "type": "boolean"
    },
    "CoolSecondStageOn": {
        "type": "boolean"
    },
    "FanSecondStageOn": {
        "type": "boolean"
    },
    "FanThirdStageOn": {
        "type": "boolean"
    }
  }
}

\section enum_time_time_status TimeTimeStatus Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "TimeTimeStatus Enum Properties",
  "type": "object",
  "properties": {
    "Master": {
        "type": "boolean"
    },
    "Synchronized": {
        "type": "boolean"
    },
    "MasterZoneDst": {
        "type": "boolean"
    },
    "Superseding": {
        "type": "boolean"
    }
  }
}

\section enum_tstat_scheduledow TstatScheduleDOW Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "TstatScheduleDOW Enum Properties",
  "type": "object",
  "properties": {
    "Sunday": {
        "type": "boolean"
    },
    "Monday": {
        "type": "boolean"
    },
    "Tuesday": {
        "type": "boolean"
    },
    "Wednesday": {
        "type": "boolean"
    },
    "Thursday": {
        "type": "boolean"
    },
    "Friday": {
        "type": "boolean"
    },
    "Saturday": {
        "type": "boolean"
    },
    "AwayOrVacation": {
        "type": "boolean"
    }
  }
}

\section enum_tstat_schedule_mode TstatScheduleMode Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "TstatScheduleMode Enum Properties",
  "type": "object",
  "properties": {
    "Heat": {
        "type": "boolean"
    },
    "Cool": {
        "type": "boolean"
    }
  }
}

\section enum_window_covering_config_or_status WindowCoveringConfigOrStatus Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindowCoveringConfigOrStatus Enum Properties",
  "type": "object",
  "properties": {
    "Operational": {
        "type": "boolean"
    },
    "Online": {
        "type": "boolean"
    },
    "OpenAndUpCommandsReversed": {
        "type": "boolean"
    },
    "LiftClosedLoop": {
        "type": "boolean"
    },
    "TiltClosedLoop": {
        "type": "boolean"
    },
    "LiftEncoderControlled": {
        "type": "boolean"
    },
    "TiltEncoderControlled": {
        "type": "boolean"
    }
  }
}

\section enum_window_covering_mode WindowCoveringMode Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindowCoveringMode Enum Properties",
  "type": "object",
  "properties": {
    "MotorDirectionReversed": {
        "type": "boolean"
    },
    "CalibrationMode": {
        "type": "boolean"
    },
    "MaintenanceMode": {
        "type": "boolean"
    },
    "LEDFeedback": {
        "type": "boolean"
    }
  }
}

\section enum_map16 map16 Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "map16 Enum Properties",
  "type": "object",
  "properties": {
  }
}

\section enum_map24 map24 Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "map24 Enum Properties",
  "type": "object",
  "properties": {
  }
}

\section enum_map32 map32 Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "map32 Enum Properties",
  "type": "object",
  "properties": {
  }
}

\section enum_map40 map40 Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "map40 Enum Properties",
  "type": "object",
  "properties": {
  }
}

\section enum_map48 map48 Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "map48 Enum Properties",
  "type": "object",
  "properties": {
  }
}

\section enum_map56 map56 Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "map56 Enum Properties",
  "type": "object",
  "properties": {
  }
}

\section enum_map64 map64 Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "map64 Enum Properties",
  "type": "object",
  "properties": {
  }
}

\section enum_map8 map8 Bitmap

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "map8 Enum Properties",
  "type": "object",
  "properties": {
  }
}

\page ucl_monotonous_arrays UCL Array Attributes

ZAP and DotDot do not always support very well attributes that are arrays consisting of several elements, as for example the Group or Scene Tables. In such cases, the UCL specifications have defined how to publish and interpret the values of such attributes.

The Unify library provides limited support for Attributes that are array. Protocol Controller and/or IoT Services may have to add manual code to handle these cases.

The following attributes are supported as arrays in the Unify Library.

Cluster	Attribute	Example topic
State	EndpointIdList	ucl/by-unid/zw-12345678-0001/State/Attributes/EndpointIdList/Reported
State	NetworkList	ucl/by-unid/zw-12345678-0001/State/Attributes/NetworkList/Reported
Binding	BindableClusterList	ucl/by-unid/zw-12345678-0001/ep0/Binding/Attributes/BindableClusterList/Reported
SystemMetrics	CPUUsagePercent	ucl/by-unid/zw-12345678-0001/SystemMetrics/Attributes/CPUUsagePercent/Reported
SystemMetrics	CPUFrequencyMHz	ucl/by-unid/zw-12345678-0001/SystemMetrics/Attributes/CPUFrequencyMHz/Reported
SystemMetrics	CPUAverageUsagePercent	ucl/by-unid/zw-12345678-0001/SystemMetrics/Attributes/CPUAverageUsagePercent/Reported
SystemMetrics	CPUMinUsagePercent	ucl/by-unid/zw-12345678-0001/SystemMetrics/Attributes/CPUMinUsagePercent/Reported
SystemMetrics	CPUMaxUsagePercent	ucl/by-unid/zw-12345678-0001/SystemMetrics/Attributes/CPUMaxUsagePercent/Reported
ApplicationMonitoring	ApplicationMQTTTopics	ucl/by-unid/zw-12345678-0001/ApplicationMonitoring/Attributes/ApplicationMQTTTopics/Reported
AoXLocator	AllowList	ucl/by-unid/zw-12345678-0001/ep0/AoXLocator/Attributes/AllowList/Reported
AoXLocator	AntennaArray	ucl/by-unid/zw-12345678-0001/ep0/AoXLocator/Attributes/AntennaArray/Reported

The following attributes are partially or not supported as arrays in the Unify Library. It is because these arrays contains objects themselves. For attributes not present in either lists (e.g. Group Table), refer to the Unify Specification.

Cluster	Attribute	Example topic
Scenes	SceneTable	ucl/by-unid/zw-12345678-0001/ep0/Scenes/Attributes/SceneTable/Reported
Binding	BindingTable	ucl/by-unid/zw-12345678-0001/ep0/Binding/Attributes/BindingTable/Reported
SystemMetrics	DisksUsage	ucl/by-unid/zw-12345678-0001/SystemMetrics/Attributes/DisksUsage/Reported
SystemMetrics	DisksCounters	ucl/by-unid/zw-12345678-0001/SystemMetrics/Attributes/DisksCounters/Reported
SystemMetrics	NetworkInterfacesData	ucl/by-unid/zw-12345678-0001/SystemMetrics/Attributes/NetworkInterfacesData/Reported
SystemMetrics	WirelessNetworkInterfacesData	ucl/by-unid/zw-12345678-0001/SystemMetrics/Attributes/WirelessNetworkInterfacesData/Reported
ConfigurationParameters	ConfigurationParameters	ucl/by-unid/zw-12345678-0001/ep0/ConfigurationParameters/Attributes/ConfigurationParameters/Reported
AoXLocator	AzimuthMask	ucl/by-unid/zw-12345678-0001/ep0/AoXLocator/Attributes/AzimuthMask/Reported
AoXLocator	ElevationMask	ucl/by-unid/zw-12345678-0001/ep0/AoXLocator/Attributes/ElevationMask/Reported
Descriptor	DeviceTypeList	ucl/by-unid/zw-12345678-0001/ep0/Descriptor/Attributes/DeviceTypeList/Reported